Struct breadthread::Key

pub struct Key<Type> { /* fields omitted */ }

A key. This is a wrapper around a non-zero usize that usually represents a pointer. This object represents a foreign object, usually managed by the API that the bread thread is managing. This is provided as a utility so you know that the pointer you have is a pointer to the object you’re talking about. The thread itself is able to verify that the pointer not only is not dangling, but refers to the type you are talking about.

Implementations

impl<Type> Key<Type>

pub fn from_raw(nzu: NonZeroUsize) -> Key<Type>

Create a new Key from a NonZeroUsize.

pub fn into_raw(self) -> NonZeroUsize

Get the NonZeroUsize from this Key.

pub fn cast<OtherType>(self) -> Key<OtherType>

Cast this Key into a Key of another type.

impl<Type: KeyType> Key<Type>

pub fn from_non_null(nn: NonNull<Type::Real>) -> Key<Type>

Create a new Key from a non-null pointer.

pub fn from_ptr(ptr: *mut Type::Real) -> Option<Key<Type>>

Create a new Key from a pointer. This function returns None if the pointer is null.

pub fn as_non_null(self) -> NonNull<Type::Real>

Convert this Key into a non-null pointer.

pub fn as_ptr(self) -> *mut Type::Real

Convert this Key into a pointer.

pub fn identifier(self) -> usize

Get the type identifier for this key.

pub fn verifiable(self) -> (NonZeroUsize, usize)

Get a bundle between the identifier and the actual pointer.

Trait Implementations

impl<Type: Clone> Clone for Key<Type>

fn clone(&self) -> Key<Type>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Type: Debug> Debug for Key<Type>

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

Formats the value using the given formatter.

impl<Type: Hash> Hash for Key<Type>

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<Type: Ord> Ord for Key<Type>

fn cmp(&self, other: &Key<Type>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<Type: PartialEq> PartialEq<Key<Type>> for Key<Type>

fn eq(&self, other: &Key<Type>) -> bool

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

fn ne(&self, other: &Key<Type>) -> bool

This method tests for !=.

impl<Type: PartialOrd> PartialOrd<Key<Type>> for Key<Type>

fn partial_cmp(&self, other: &Key<Type>) -> 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<Type: Copy> Copy for Key<Type>

impl<Type: Eq> Eq for Key<Type>

impl<Type> StructuralEq for Key<Type>

impl<Type> StructuralPartialEq for Key<Type>