Struct Position

pub struct Position(/* private fields */);

The position of something inside a Chunk.

It’s a pair of a chunk position and an item index.

Implementations

impl Position

pub fn new(chunk_identifier: ChunkIdentifier, index: usize) -> Position

Create a new Position.

pub fn chunk_identifier(&self) -> ChunkIdentifier

Get the chunk identifier of the item.

pub fn index(&self) -> usize

Get the index inside the chunk.

pub fn decrement_index(&mut self)

Decrement the index part (see Self::index), i.e. subtract 1.

Panic

This method will panic if it will underflow, i.e. if the index is 0.

pub fn increment_index(&mut self)

Increment the index part (see Self::index), i.e. add 1.

Panic

This method will panic if it will overflow, i.e. if the index is larger than usize::MAX.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Position

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for Position

fn eq(&self, other: &Position) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Position

impl StructuralPartialEq for Position