Struct grit_data_prison::CellKey

pub struct CellKey { /* private fields */ }

Struct that defines a packaged index into a Prison

This struct is designed to be passed to some other struct or function that needs to be able to reference the data stored at the cell number.

Implementations

impl CellKey

pub fn from_raw_parts(idx: usize, gen: usize) -> CellKey

Create a new index from an index and generation

Not recomended in most cases, as there is no way to guarantee an item with that exact index and generation exists in your Prison

pub fn into_raw_parts(&self) -> (usize, usize)

Return the internal index and generation from the cell key, in that order

Not recomended in most cases. If you need just the index by itself, use CellKey::idx() instead

pub fn idx(&self) -> usize

Return only the index of the CellKey

Useful if you want to only get the value at the specified index in the Prison without checking that the generations match

Trait Implementations

impl Clone for CellKey

fn clone(&self) -> CellKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CellKey

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

Formats the value using the given formatter.

impl PartialEq<CellKey> for CellKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for CellKey

impl Eq for CellKey

impl StructuralEq for CellKey

impl StructuralPartialEq for CellKey