Struct HandleGenExample 

pub struct HandleGenExample { /* private fields */ }

✨ 🫆 An example generational handle.

---

^{📍 data/id/handle::HandleGenExample}

^{📦 size_of::<HandleGenExample>() == 4 bytes / 32 bits ⚗️Option<T> 🟰 T}

---

Generated by handle_gen!.

Demonstrates a generational handle with an index and niche-aware generation.

Methods

• Core handle methods: new, from_prim, try_from_usize, into_parts, into_prim, eq.
• Component access: each field exposes get_<field>, get_<field>_prim, and get_<field>_usize.
• Canonical Word representation: raw, from_raw, try_from_raw.
• Scalar packing: PACK_BITS, try_pack_u8 … try_pack_u128, try_unpack_u8 … try_unpack_u128.

• Index: get_index, get_index_prim, get_index_usize.
• Generation: get_generation, get_generation_prim, get_generation_usize.

Implementations

impl HandleGenExample

Core handle methods

Construction, decomposition and const-compatible comparison.

pub const fn new(index: u8, generation: NonMaxU16) -> Self

Creates a new handle from its representation components.

pub const fn from_prim(index: u8, generation: u16) -> Result<Self, InvalidValue>

Creates a new handle from primitive carrier components.

Returns an error if any component violates its representation invariant.

pub const fn try_from_usize( index: usize, generation: usize, ) -> Result<Self, NicheValueError>

Creates a new handle from usize components.

Returns an error if any value does not fit its primitive carrier or violates its representation invariant.

pub const fn into_parts(self) -> (u8, NonMaxU16)

Returns the representation components in declaration order.

pub const fn into_prim(self) -> (u8, u16)

Returns the primitive carrier components in declaration order.

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

Returns whether this handle has the same component values as other.

impl HandleGenExample

Methods for index

pub const fn get_index(self) -> u8

Returns the index component.

pub const fn get_index_prim(self) -> u8

Returns the index component as its primitive carrier.

pub const fn get_index_usize(self) -> Result<usize, Overflow>

Returns the index component as a usize.

Errors

Returns an error if the component cannot fit in a usize.

impl HandleGenExample

Methods for generation

pub const fn get_generation(self) -> NonMaxU16

Returns the generation component.

pub const fn get_generation_prim(self) -> u16

Returns the generation component as its primitive carrier.

pub const fn get_generation_usize(self) -> Result<usize, Overflow>

Returns the generation component as a usize.

Errors

Returns an error if the component cannot fit in a usize.

impl HandleGenExample

pub const fn raw(self) -> (u8, NonMaxU16)

Returns the canonical raw representation.

pub const fn from_raw(raw: (u8, NonMaxU16)) -> Self

Reconstructs the word exactly from any raw representation.

pub const fn try_from_raw(raw: (u8, NonMaxU16)) -> Result<Self, Infallible>

Attempts to reconstruct the word from its raw representation.

impl HandleGenExample

Scalar packing

Packs the primitive component bits into unsigned scalar carriers.

pub const PACK_BITS: u32

The total bit width of all primitive components.

Components occupy bits from low to high in declaration order.

pub const fn try_pack_u8(self) -> Option<u8>

Tries to pack this handle into a u8.

Primitive component bits are placed from low to high in declaration order.

Returns None if the complete value cannot be represented by the target scalar.

pub const fn try_unpack_u8(packed: u8) -> Result<Self, InvalidValue>

Tries to reconstruct this handle from a packed u8.

Primitive component bits are read from low to high in declaration order.

Errors

Returns an error if extra bits are set or a component violates its invariant.

pub const fn try_pack_u16(self) -> Option<u16>

Tries to pack this handle into a u16.

Primitive component bits are placed from low to high in declaration order.

Returns None if the complete value cannot be represented by the target scalar.

pub const fn try_unpack_u16(packed: u16) -> Result<Self, InvalidValue>

Tries to reconstruct this handle from a packed u16.

Primitive component bits are read from low to high in declaration order.

Errors

Returns an error if extra bits are set or a component violates its invariant.

pub const fn try_pack_u32(self) -> Option<u32>

Tries to pack this handle into a u32.

Primitive component bits are placed from low to high in declaration order.

Returns None if the complete value cannot be represented by the target scalar.

pub const fn try_unpack_u32(packed: u32) -> Result<Self, InvalidValue>

Tries to reconstruct this handle from a packed u32.

Primitive component bits are read from low to high in declaration order.

Errors

Returns an error if extra bits are set or a component violates its invariant.

pub const fn try_pack_u64(self) -> Option<u64>

Tries to pack this handle into a u64.

Primitive component bits are placed from low to high in declaration order.

Returns None if the complete value cannot be represented by the target scalar.

pub const fn try_unpack_u64(packed: u64) -> Result<Self, InvalidValue>

Tries to reconstruct this handle from a packed u64.

Primitive component bits are read from low to high in declaration order.

Errors

Returns an error if extra bits are set or a component violates its invariant.

pub const fn try_pack_u128(self) -> Option<u128>

Tries to pack this handle into a u128.

Primitive component bits are placed from low to high in declaration order.

Returns None if the complete value cannot be represented by the target scalar.

pub const fn try_unpack_u128(packed: u128) -> Result<Self, InvalidValue>

Tries to reconstruct this handle from a packed u128.

Primitive component bits are read from low to high in declaration order.

Errors

Returns an error if extra bits are set or a component violates its invariant.

Trait Implementations

impl Clone for HandleGenExample

fn clone(&self) -> HandleGenExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HandleGenExample

impl Debug for HandleGenExample

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

Formats the value using the given formatter.

impl Eq for HandleGenExample

impl Hash for HandleGenExample

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 Ord for HandleGenExample

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for HandleGenExample

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HandleGenExample

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for HandleGenExample

impl WordTry for HandleGenExample

type Repr = (u8, NonValueU16<{$IP::$XTR}>)

The canonical raw representation.

type Error = !

The error returned when a raw representation is not admitted.

fn raw(self) -> Self::Repr

Returns the canonical raw representation.

fn try_from_raw(raw: Self::Repr) -> Result<Self, Self::Error>

Attempts exact reconstruction from a raw representation.