Skip to main content

Key

Struct Key 

Source
pub struct Key(/* private fields */);
Expand description

Opaque handle to an allocated slot.

A Key is simply an index into the slab. It does not contain a generation counter or any other validation mechanism.

§Design Rationale: No Generational Indices

This slab intentionally omits generational indices (ABA protection). Why?

The slab is dumb storage, not a source of truth.

In real systems, your data has authoritative external identifiers:

  • Exchange order IDs in trading systems
  • Database primary keys in web services
  • Session tokens in connection managers

When you receive a message referencing an entity, you must validate against the authoritative identifier anyway:

fn on_fill(fill: Fill, key: Key) {
    let Some(order) = slab.get(key) else { return };

    // This check is REQUIRED regardless of generational indices
    if order.exchange_id != fill.exchange_id {
        panic!("order mismatch");
    }

    // Process...
}

Generational indices would catch the same bug that domain validation catches, but at a cost of ~8 cycles per operation. Since domain validation is unavoidable, generations provide no additional safety—only overhead.

If a stale key reaches the slab, your architecture has a bug. The fix is to correct the architecture (clear ownership, proper state machines), not to add runtime checks that mask the underlying problem.

§Sentinel

Key::NONE represents an invalid/absent key, useful for optional key fields without Option overhead.

Implementations§

Source§

impl Key

Source

pub const NONE: Self

Sentinel value representing no key / invalid key.

Equivalent to SLOT_NONE. Check with is_none.

Source

pub const fn index(self) -> u32

Returns the slot index.

For bounded slabs, this is the direct slot index. For unbounded slabs, this encodes chunk and local index via power-of-2 arithmetic.

Source

pub const fn is_none(self) -> bool

Returns true if this is the Key::NONE sentinel.

Source

pub const fn is_some(self) -> bool

Returns true if this is a valid key (not Key::NONE).

Source

pub const fn into_raw(self) -> u32

Returns the raw u32 representation.

Useful for serialization or FFI.

Source

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

Constructs a key from a raw u32 value.

No safety invariants—any u32 is valid. However, using a key not returned by this slab’s insert will return None or wrong data.

Trait Implementations§

Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Key

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Key

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Key

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Key

Source§

impl Eq for Key

Source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.