Struct Handle 

pub struct Handle<K: Kind> { /* private fields */ }

A generational index naming one object of kind K.

index is the arena slot (at most Handle::MAX_INDEX); generation is the slot’s generation at creation, and is never zero for a live handle — generation 0 is Handle::NULL, the C kernel’s NULL handle.

Implementations

impl<K: Kind> Handle<K>

pub const MAX_INDEX: u16

The largest slot index a handle can name (the arena capacity bound).

pub const NULL: Self

The null handle: names nothing, resolves to Error::InvalidHandle. What NULL means to xTaskGetHandle.

pub const fn from_parts(index: u16, generation: u16) -> Self

A handle for index at generation. The arena is the only intended caller; a generation of zero yields the null handle.

pub const fn index(self) -> u16

The arena slot this handle names.

pub const fn generation(self) -> u16

The slot generation this handle was minted at (zero for the null handle).

pub const fn is_null(self) -> bool

Whether this is the null handle.

pub const fn to_raw(self) -> u32

The handle as one u32 for the C ABI: generation in the high half, index in the low half. The null handle is 0, exactly NULL.

pub const fn from_raw(raw: u32) -> Self

A handle from its C-ABI form. Never fails: a zero is the null handle, anything else is checked by the arena it is presented to.

pub const fn non_null(self) -> Result<Self>

This handle, or Error::InvalidHandle if it is null.

Errors

Error::InvalidHandle for the null handle.

Trait Implementations

impl<K: Kind> Clone for Handle<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Kind> Copy for Handle<K>

impl<K: Kind> Debug for Handle<K>

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

Formats the value using the given formatter.

impl<K: Kind> Default for Handle<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Kind> Display for Handle<K>

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

Formats the value using the given formatter.

impl<K: Kind> Eq for Handle<K>

impl<K: Kind> Hash for Handle<K>

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<K: Kind> PartialEq for Handle<K>

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

Equality operator ==.

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

Inequality operator !=.