Struct ThreadMap

pub struct ThreadMap<V> { /* private fields */ }

This type encapsulates the association of ThreadIds to values of type V. It is a simple and easy-to-use alternative to the std::thread_local macro and the thread_local crate.

Implementations

impl<V> ThreadMap<V>

pub fn new(value_init: fn() -> V) -> Self

Creates a new ThreadMap instance, with value_init used to create the initial value for each thread.

pub fn with_mut<W>(&self, f: impl FnOnce(&mut V) -> W) -> W

Invokes f mutably on the value associated with the ThreadId of the current thread and returns the invocation result. If there is no value associated with the current thread then the value_init argument of Self::new is used to instantiate an initial associated value before f is applied.

pub fn with<W>(&self, f: impl FnOnce(&V) -> W) -> W

Invokes f on the value associated with the ThreadId of the current thread and returns the invocation result. If there is no value associated with the current thread then the value_init argument of Self::new is used to instantiate an initial associated value before f is applied.

pub fn drain(&self) -> Result<HashMap<ThreadId, V>, ThreadMapLockError>

Returns a HashMap with the values associated with each ThreadId key and clears self’s state.

Errors

• ThreadMapLockError if the internal lock is poisoned.

pub fn fold<W>( &self, z: W, f: impl FnMut(W, (ThreadId, &V)) -> W, ) -> Result<W, ThreadMapLockError>

Folds every association in self into an accumulator (with initial value z) by applying an operation f, returning the final result.

Errors

• ThreadMapLockError if the internal lock is poisoned.

pub fn fold_values<W>( &self, z: W, f: impl FnMut(W, &V) -> W, ) -> Result<W, ThreadMapLockError>

Folds every value in self into an accumulator (with initial value z) by applying an operation f, returning the final result.

Errors

• ThreadMapLockError if the internal lock is poisoned.

pub fn probe(&self) -> Result<HashMap<ThreadId, V>, ThreadMapLockError>

where V: Clone,

Returns a HashMap with clones of the values associated with each ThreadId key at the time the probe was executed.

Errors

• ThreadMapLockError if the internal lock is poisoned.

Trait Implementations

impl<V: Debug> Debug for ThreadMap<V>

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

Formats the value using the given formatter.