Struct HandleSpanExample 

pub struct HandleSpanExample { /* private fields */ }

✨ 🫆 An example span handle.

---

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

^{📦 size_of::<HandleSpanExample>() == 2 bytes / 16 bits ⚗️Option<T> 🟰 T}

---

Generated by handle_span!.

Demonstrates a minimal span-handle using niche-aware u8 storage.

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.

• Offset: get_offset, get_offset_prim, get_offset_usize.
• Length: get_len, get_len_prim, get_len_usize, is_empty.

Implementations

impl HandleSpanExample

Core handle methods

Construction, decomposition and const-compatible comparison.

pub const fn new(offset: NonMaxU8, len: NonMaxU8) -> Self

Creates a new handle from its representation components.

pub const fn from_prim(offset: u8, len: u8) -> 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( offset: usize, len: 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) -> (NonMaxU8, NonMaxU8)

Returns the representation components in declaration order.

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

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 HandleSpanExample

Methods for offset

pub const fn get_offset(self) -> NonMaxU8

Returns the offset component.

pub const fn get_offset_prim(self) -> u8

Returns the offset component as its primitive carrier.

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

Returns the offset component as a usize.

Errors

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

impl HandleSpanExample

Methods for len

pub const fn get_len(self) -> NonMaxU8

Returns the len component.

pub const fn get_len_prim(self) -> u8

Returns the len component as its primitive carrier.

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

Returns the len component as a usize.

Errors

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

impl HandleSpanExample

pub const fn raw(self) -> (NonMaxU8, NonMaxU8)

Returns the canonical raw representation.

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

Reconstructs the word exactly from any raw representation.

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

Attempts to reconstruct the word from its raw representation.

impl HandleSpanExample

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.

impl HandleSpanExample

pub const fn is_empty(self) -> bool

Returns whether this span has zero length.

Trait Implementations

impl Clone for HandleSpanExample

fn clone(&self) -> HandleSpanExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for HandleSpanExample

const INIT: Self

Returns the compile-time “initial value” for a type.

impl Copy for HandleSpanExample

impl Debug for HandleSpanExample

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

Formats the value using the given formatter.

impl Default for HandleSpanExample

fn default() -> Self

Returns the “default value” for a type.

impl Eq for HandleSpanExample

impl Hash for HandleSpanExample

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 PartialEq for HandleSpanExample

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HandleSpanExample

impl WordTry for HandleSpanExample

type Repr = (NonValueU8<{$IP::$XTR}>, NonValueU8<{$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.