Struct handy::typed::TypedHandle

#[repr(transparent)]pub struct TypedHandle<T> { /* fields omitted */ }

A TypedHandle is a wrapper around a Handle which gives you some additional type safety, should you desire. You use it with a TypedHandleMap, which only will accept handles of the correct type. This could be useful if you have several handle maps in your program, and find

TypedHandle<T> is Copy + Send + Sync (and several others) regardless of T, which is not true for a naïve implementation of this, so it's provided even though I don't think it's that helpful for most usage (handle maps already detect this at runtime).

Implementations

impl<T> TypedHandle<T>

pub const EMPTY: Self

The TypedHandle equivalent of Handle::EMPTY.

pub const fn from_handle(h: Handle) -> Self

Construct a typed handle from an untyped Handle.

This typically shouldn't be necessary if you're using typed maps exclusively, but could be useful when building abstractions on top of handles.

pub const fn handle(self) -> Handle

Access the wrapped untyped handle.

This typically shouldn't be necessary if you're using typed maps exclusively, but could be useful when building abstractions on top of handles, as well as for accessing the accessors on Handle which are not otherwise directly exposed on TypedHandle.

pub const fn from_raw_parts(index: usize, generation: u16, meta: u16) -> Self

Construct a handle from the separate parts.

Warning

This is a feature intended for advanced usage. An attempt is made to cope with dubious handles, but it's almost certainly possible to pierce the abstraction veil of the HandleMap if you use this.

However, it should not be possible to cause memory unsafety -- this crate has no unsafe code.

pub const fn from_raw(value: u64) -> Self

Construct a handle from it's internal u64 value.

See the documentation for Handle::from_raw for further info.

Warning

This is a feature intended for advanced usage. An attempt is made to cope with dubious handles, but it's almost certainly possible to pierce the abstraction veil of the HandleMap if you use this.

However, it should not be possible to cause memory unsafety -- this crate has no unsafe code.

pub const fn into_raw(self) -> u64

Get the internal u64 representation of this handle.

See the documentation for Handle::into_raw for further info.

pub const fn index(self) -> usize

Returns the index value of this handle.

While a usize is returned, this value is guaranteed to be 32 bits.

See the documentation for Handle::index for further info.

pub const fn generation(self) -> u16

Returns the generation value of this handle.

See the documentation for Handle::generation for further info.

pub const fn meta(self) -> u16

Returns the metadata field of this handle.

See the documentation for Handle::meta for further info.

pub const fn map_id(self) -> u16

Returns the metadata field of this handle. This is an alias for map_id, as in the common case, this is what the metadata field is used for.

See Handle::meta for more info.

Trait Implementations

impl<T> Clone for TypedHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for TypedHandle<T>

impl<T> Debug for TypedHandle<T>

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

Formats the value using the given formatter.

impl<T> Default for TypedHandle<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Eq for TypedHandle<T>

impl<T> Hash for TypedHandle<T>

fn hash<H: Hasher>(&self, h: &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<TypedHandle<T>> for TypedHandleMap<T>

type Output = T

The returned type after indexing.

fn index(&self, h: TypedHandle<T>) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<TypedHandle<T>> for TypedHandleMap<T>

fn index_mut(&mut self, h: TypedHandle<T>) -> &mut T

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

impl<T> Ord for TypedHandle<T>

fn cmp(&self, o: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T> PartialEq<TypedHandle<T>> for TypedHandle<T>

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

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

fn ne(&self, o: &Self) -> bool

This method tests for !=.

impl<T> PartialOrd<TypedHandle<T>> for TypedHandle<T>

fn partial_cmp(&self, o: &Self) -> Option<Ordering>

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

fn lt(&self, o: &Self) -> bool

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

fn le(&self, o: &Self) -> bool

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

fn ge(&self, o: &Self) -> bool

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

fn gt(&self, o: &Self) -> bool

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