Struct sharded_slab::Slab

pub struct Slab<T, C: Config = DefaultConfig> { /* fields omitted */ }

A sharded slab.

See the crate-level documentation for details on using this type.

Methods

impl<T> Slab<T>

pub fn new() -> Self

Returns a new slab with the default configuration parameters.

pub fn new_with_config<C: Config>() -> Slab<T, C>

Returns a new slab with the provided configuration parameters.

impl<T, C: Config> Slab<T, C>

pub const USED_BITS: usize

The number of bits in each index which are used by the slab.

If other data is packed into the usize indices returned by Slab::insert, user code is free to use any bits higher than the USED_BITS-th bit freely.

This is determined by the Config type that configures the slab's parameters. By default, all bits are used; this can be changed by overriding the Config::RESERVED_BITS constant.

pub fn insert(&self, value: T) -> Option<usize>

Inserts a value into the slab, returning a key that can be used to access it.

If this function returns None, then the shard for the current thread is full and no items can be added until some are removed, or the maximum number of shards has been reached.

Examples

let slab = Slab::new();

let key = slab.insert("hello world").unwrap();
assert_eq!(slab.get(key), Some(&"hello world"));

pub fn remove(&self, idx: usize) -> Option<T>

Removes the value associated with the given key from the slab, returning it.

If the slab does not contain a value for that key, None is returned instead.

pub fn get(&self, key: usize) -> Option<&T>

Return a reference to the value associated with the given key.

If the slab does not contain a value for the given key, None is returned instead.

Examples

let slab = sharded_slab::Slab::new();
let key = slab.insert("hello world").unwrap();

assert_eq!(slab.get(key), Some(&"hello world"));
assert_eq!(slab.get(12345), None);

pub fn contains(&self, key: usize) -> bool

Returns true if the slab contains a value for the given key.

Examples

let slab = sharded_slab::Slab::new();

let key = slab.insert("hello world").unwrap();
assert!(slab.contains(key));

slab.remove(key).unwrap();
assert!(!slab.contains(key));

pub fn len(&self) -> usize

Returns the number of items currently stored in the slab.

pub fn capacity(&self) -> usize

Returns the current number of items which may be stored in the slab without allocating.

pub fn unique_iter<'a>(&'a mut self) -> UniqueIter<'a, T, C>

Returns an iterator over all the items in the slab.

Trait Implementations

impl<T: Send, C: Config> Send for Slab<T, C>

impl<T: Sync, C: Config> Sync for Slab<T, C>

impl<T: Debug, C: Config> Debug for Slab<T, C>

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

Formats the value using the given formatter.