Struct obj_pool::ObjId

pub struct ObjId(pub u32);

An id of the object in an ObjPool.

In release it is basically just an index in the underlying vector, but in debug it's an index + ObjPool-specific offset. This is made to be able to check ObjId if it's from the same ObjPool we are trying to get an object from.

Methods

impl ObjId

pub fn into_index(self, offset: u32) -> u32

pub fn from_index(index: u32, offset: u32) -> ObjId

Trait Implementations

impl Clone for ObjId

fn clone(&self) -> ObjId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ObjId> for ObjId

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

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

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

This method tests for !=.

impl Eq for ObjId

impl Copy for ObjId

impl From<u32> for ObjId

fn from(v: u32) -> ObjId

Performs the conversion.

impl Deref for ObjId

type Target = u32

The resulting type after dereferencing.

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

Dereferences the value.

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, 

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 Debug for ObjId

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

Formats the value using the given formatter.

impl Display for ObjId

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

Formats the value using the given formatter.

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 Noned for ObjId

fn is_none(&self) -> bool

Returns true if the contained value is the declared None for T, false otherwise.

fn get_none() -> ObjId

Returns the declared None value for T.

impl OptEq for ObjId

fn opt_eq(&self, other: &Self) -> bool

Is the other optioned equal to this one?