Struct thread_local::CachedThreadLocal

pub struct CachedThreadLocal<T: Send> { /* fields omitted */ }

Wrapper around ThreadLocal which adds a fast path for a single thread.

This has the same API as ThreadLocal, but will register the first thread that sets a value as its owner. All accesses by the owner will go through a special fast path which is much faster than the normal ThreadLocal path.

Implementations

impl<T: Send> CachedThreadLocal<T>

pub fn new() -> CachedThreadLocal<T>

Creates a new empty CachedThreadLocal.

pub fn get(&self) -> Option<&T>

Returns the element for the current thread, if it exists.

pub fn get_or<F>(&self, create: F) -> &T where
    F: FnOnce() -> T, 

Returns the element for the current thread, or creates it if it doesn’t exist.

pub fn get_or_try<F, E>(&self, create: F) -> Result<&T, E> where
    F: FnOnce() -> Result<T, E>, 

Returns the element for the current thread, or creates it if it doesn’t exist. If create fails, that error is returned and no element is added.

pub fn iter_mut(&mut self) -> CachedIterMut<'_, T>

Returns a mutable iterator over the local values of all threads.

Since this call borrows the ThreadLocal mutably, this operation can be done safely—the mutable borrow statically guarantees no other threads are currently accessing their associated values.

pub fn clear(&mut self)

Removes all thread-specific values from the ThreadLocal, effectively reseting it to its original state.

Since this call borrows the ThreadLocal mutably, this operation can be done safely—the mutable borrow statically guarantees no other threads are currently accessing their associated values.

impl<T: Send + Default> CachedThreadLocal<T>

pub fn get_or_default(&self) -> &T

Returns the element for the current thread, or creates a default one if it doesn’t exist.

Trait Implementations

impl<T: Send + Debug> Debug for CachedThreadLocal<T>

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

Formats the value using the given formatter.

impl<T: Send> Default for CachedThreadLocal<T>

fn default() -> CachedThreadLocal<T>

Returns the “default value” for a type.

impl<T: Send> IntoIterator for CachedThreadLocal<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = CachedIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> CachedIntoIter<T>

Creates an iterator from a value.

impl<'a, T: Send + 'a> IntoIterator for &'a mut CachedThreadLocal<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = CachedIterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> CachedIterMut<'a, T>

Creates an iterator from a value.

impl<T: Send> Sync for CachedThreadLocal<T>

impl<T: Send + UnwindSafe> UnwindSafe for CachedThreadLocal<T>