Skip to main content

SlotMap

Struct SlotMap 

Source
pub struct SlotMap<'a, T: Pod + FixedLayout> { /* private fields */ }
Expand description

Fixed-slot map overlaid on a byte slice.

  • O(1) insert (into free slot), O(1) remove, O(1) access by SlotKey.
  • Generation counters prevent ABA bugs.
  • Used for registries, entity systems, order books with stable handles.

Implementations§

Source§

impl<'a, T: Pod + FixedLayout> SlotMap<'a, T>

Source

pub fn from_bytes(data: &'a mut [u8]) -> Result<Self, ProgramError>

Overlay a SlotMap on a mutable byte slice.

Source

pub fn capacity(&self) -> usize

Maximum capacity (number of slots).

Source

pub fn count(&self) -> usize

Current number of occupied slots.

Source

pub fn insert(&mut self, value: T) -> Result<SlotKey, ProgramError>

Insert a value, returning a SlotKey handle.

Scans for the first free slot. O(capacity) worst case.

Source

pub fn get(&self, key: SlotKey) -> Result<T, ProgramError>

Get a value by key. Returns error if generation doesn’t match.

Source

pub fn remove(&mut self, key: SlotKey) -> Result<T, ProgramError>

Remove a value by key. Bumps the generation counter.

Source

pub const fn required_bytes(capacity: usize) -> usize

Compute the byte size needed for a SlotMap with the given capacity.

Auto Trait Implementations§

§

impl<'a, T> Freeze for SlotMap<'a, T>

§

impl<'a, T> RefUnwindSafe for SlotMap<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for SlotMap<'a, T>
where T: Send,

§

impl<'a, T> Sync for SlotMap<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for SlotMap<'a, T>
where T: Unpin,

§

impl<'a, T> UnsafeUnpin for SlotMap<'a, T>

§

impl<'a, T> !UnwindSafe for SlotMap<'a, T>

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> 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, 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.