[−][src]Struct sharded_slab::Slab
A sharded slab.
See the crate-level documentation for details on using this type.
Methods
impl<T> Slab<T>
[src]
pub fn new() -> Self
[src]
Returns a new slab with the default configuration parameters.
pub fn new_with_config<C: Config>() -> Slab<T, C>
[src]
Returns a new slab with the provided configuration parameters.
impl<T, C: Config> Slab<T, C>
[src]
pub const USED_BITS: usize
[src]
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>
[src]
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).unwrap(), "hello world");
pub fn remove(&self, idx: usize) -> bool
[src]
Remove the value associated with the given key from the slab, returning
true
if a value was removed.
Unlike take
, this method does not block the current thread until
the value can be removed. Instead, if another thread is currently
accessing that value, this marks it to be removed by that thread when it
finishes accessing the value.
Examples
let slab = sharded_slab::Slab::new(); let key = slab.insert("hello world").unwrap(); // Remove the item from the slab. assert!(slab.remove(key)); // Now, the slot is empty. assert!(!slab.contains(key));
use std::sync::Arc; let slab = Arc::new(sharded_slab::Slab::new()); let key = slab.insert("hello world").unwrap(); let slab2 = slab.clone(); let thread2 = std::thread::spawn(move || { // Depending on when this thread begins executing, the item may // or may not have already been removed... if let Some(item) = slab2.get(key) { assert_eq!(item, "hello world"); } }); // The item will be removed by thread2 when it finishes accessing it. assert!(slab.remove(key)); thread2.join().unwrap(); assert!(!slab.contains(key));
pub fn take(&self, idx: usize) -> Option<T>
[src]
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.
If the value associated with the given key is currently being
accessed by another thread, this method will block the current thread
until the item is no longer accessed. If this is not desired, use
remove
instead.
Note: This method blocks the calling thread by spinning until the
currently outstanding references are released. Spinning for long periods
of time can result in high CPU time and power consumption. Therefore,
take
should only be called when other references to the slot are
expected to be dropped soon (e.g., when all accesses are relatively
short).
Examples
let slab = sharded_slab::Slab::new(); let key = slab.insert("hello world").unwrap(); // Remove the item from the slab, returning it. assert_eq!(slab.take(key), Some("hello world")); // Now, the slot is empty. assert!(!slab.contains(key));
use std::sync::Arc; let slab = Arc::new(sharded_slab::Slab::new()); let key = slab.insert("hello world").unwrap(); let slab2 = slab.clone(); let thread2 = std::thread::spawn(move || { // Depending on when this thread begins executing, the item may // or may not have already been removed... if let Some(item) = slab2.get(key) { assert_eq!(item, "hello world"); } }); // The item will only be removed when the other thread finishes // accessing it. assert_eq!(slab.take(key), Some("hello world")); thread2.join().unwrap(); assert!(!slab.contains(key));
pub fn get(&self, key: usize) -> Option<Guard<T, C>>
[src]
Return a reference to the value associated with the given key.
If the slab does not contain a value for the given key, or if the
maximum number of concurrent references to the slot has been reached,
None
is returned instead.
Examples
let slab = sharded_slab::Slab::new(); let key = slab.insert("hello world").unwrap(); assert_eq!(slab.get(key).unwrap(), "hello world"); assert!(slab.get(12345).is_none());
pub fn contains(&self, key: usize) -> bool
[src]
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.take(key).unwrap(); assert!(!slab.contains(key));
pub fn unique_iter(&mut self) -> UniqueIter<T, C>
[src]
Returns an iterator over all the items in the slab.
Trait Implementations
impl<T: Debug, C: Config> Debug for Slab<T, C>
[src]
impl<T> Default for Slab<T>
[src]
impl<T: Send, C: Config> Send for Slab<T, C>
[src]
impl<T: Sync, C: Config> Sync for Slab<T, C>
[src]
Auto Trait Implementations
impl<T, C = DefaultConfig> !RefUnwindSafe for Slab<T, C>
impl<T, C> Unpin for Slab<T, C> where
C: Unpin,
C: Unpin,
impl<T, C> UnwindSafe for Slab<T, C> where
C: UnwindSafe,
T: UnwindSafe,
C: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,