Struct ObjId 

pub struct ObjId(pub NonZeroU32);

An id of the object in an ObjPool.

In release builds it is basically just an index in the underlying vector (plus one). In debug builds every pool additionally mixes a random pool-specific offset into each ObjId it issues, so an ObjId created by one pool is (with overwhelming probability) rejected when used with another pool instead of silently aliasing an unrelated object.

Tuple Fields

0: NonZeroU32

Implementations

impl ObjId

pub fn from_index(index: u32) -> Self

Creates an ObjId from a raw index, without any pool-specific masking.

Note: in debug builds every pool mixes a random pool-specific offset into the ids it issues, so to create an id valid for a particular pool use ObjPool::index_to_obj_id instead.

pub const fn into_index(self) -> u32

Converts the ObjId into a raw index, without any pool-specific unmasking.

Note: in debug builds every pool mixes a random pool-specific offset into the ids it issues, so to get the slot index of an id use ObjPool::obj_id_to_index instead.

Trait Implementations

impl Clone for ObjId

fn clone(&self) -> ObjId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObjId

impl Debug for ObjId

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

Formats the value using the given formatter.

impl Deref for ObjId

type Target = NonZero<u32>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ObjId

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

Formats the value using the given formatter.

impl Eq for ObjId

impl From<NonZero<u32>> for ObjId

fn from(v: NonZeroU32) -> ObjId

Converts to this type from the input type.

impl FromStr for ObjId

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ObjId

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<ObjId> for ObjPool<T>

type Output = T

The returned type after indexing.

fn index(&self, obj_id: ObjId) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<ObjId> for ObjPool<T>

fn index_mut(&mut self, obj_id: ObjId) -> &mut T

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

impl PartialEq for ObjId

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