Struct alot::LotId

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

A LotId is a single usize, encoding generation information in the top 1/4 of the bits, and index information in the remaining bits. This table shows the breakdown for supported target platforms:

target_pointer_width	generation bits	index bits
16	4	12
32	8	24
64	16	48

Each time a lot is allocated, its generation is incremented. When retrieving values using a LotId, the generation is validated as a safe guard against returning a value. Because the generation isn’t significantly wide, the generation can wrap and is not a perfect protection against stale data, although the likelihood of improper access is greatly reduced.

Implementations

impl LotId

pub const fn as_bytes(self) -> [u8; 8]

Returns this ID as bytes. To decode the resulting bytes, use from_bytes().

The result of this fuction changes size based on the width of usize.

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

Decodes bytes that were previously encoded with as_bytes() and returns a LotId if it appears to be a valid ID.

This function will “upgrade” previously encoded LotIds from architectures where usize is smaller than the current architecture.

Trait Implementations

impl Clone for LotId

fn clone(&self) -> LotId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LotId

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

Formats the value using the given formatter.

impl Hash for LotId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<LotId> for Lots<T>

type Output = T

The returned type after indexing.

fn index(&self, id: LotId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<LotId> for OrderedLots<T>

type Output = T

The returned type after indexing.

fn index(&self, index: LotId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<LotId> for Lots<T>

fn index_mut(&mut self, id: LotId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<LotId> for OrderedLots<T>

fn index_mut(&mut self, index: LotId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for LotId

fn cmp(&self, other: &LotId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LotId

fn eq(&self, other: &LotId) -> 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 PartialOrd for LotId

fn partial_cmp(&self, other: &LotId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for LotId

impl Eq for LotId

impl StructuralEq for LotId

impl StructuralPartialEq for LotId