Skip to main content

Handle

Struct Handle 

Source
pub struct Handle<T> { /* private fields */ }
Expand description

A typed, generational reference to a value stored in a Pool<T>.

See the module docs for the representation and variance rationale.

Implementations§

Source§

impl<T> Handle<T>

Source

pub const fn index(self) -> u32

The slot index this handle points at.

Source

pub const fn generation(self) -> u32

The generation this handle was issued with.

Never zero — see the module docs.

Source

pub const fn to_bits(self) -> u64

Packs the handle into a u64 (generation in the high half).

The packed form is stable and never zero, which makes it safe to use as a wire/serialization representation with 0 reserved for “none”.

Source

pub const fn from_bits(bits: u64) -> Option<Self>

Unpacks a handle produced by Handle::to_bits.

Returns None if the generation half is zero, which no real handle ever has.

Source

pub const fn cast<U>(self) -> Handle<U>

Reinterprets the handle as naming a different type.

Useful only at seams that erase types (e.g. a generic resource table); the result is meaningless in any other pool.

Trait Implementations§

Source§

impl<T> Clone for Handle<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Copy for Handle<T>

Source§

impl<T> Debug for Handle<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Eq for Handle<T>

Source§

impl<T> Hash for Handle<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T> PartialEq for Handle<T>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Handle<T>
where PhantomData<fn() -> T>: Freeze,

§

impl<T> RefUnwindSafe for Handle<T>
where PhantomData<fn() -> T>: RefUnwindSafe,

§

impl<T> Send for Handle<T>
where PhantomData<fn() -> T>: Send,

§

impl<T> Sync for Handle<T>
where PhantomData<fn() -> T>: Sync,

§

impl<T> Unpin for Handle<T>
where PhantomData<fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for Handle<T>
where PhantomData<fn() -> T>: UnsafeUnpin,

§

impl<T> UnwindSafe for Handle<T>
where PhantomData<fn() -> T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.