Struct ThreadLocal 

pub struct ThreadLocal<T>
where
    T: Send,
{ /* private fields */ }

Thread-local variable wrapper

See the module-level documentation for more.

Implementations

impl<T> ThreadLocal<T>

where T: Send,

pub const fn new() -> ThreadLocal<T>

Creates a new empty ThreadLocal.

pub fn with_capacity(capacity: usize) -> ThreadLocal<T>

Creates a new ThreadLocal with an initial capacity. If less than the capacity threads access the thread local it will never reallocate. The capacity may be rounded up to the nearest power of two.

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(&self) -> Iter<'_, T>

where T: Sync,

Returns an iterator over the local values of all threads in unspecified order.

This call can be done safely, as T is required to implement Sync.

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

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

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> ThreadLocal<T>

where T: Send + Default,

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> Debug for ThreadLocal<T>

where T: Send + Debug,

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

Formats the value using the given formatter.

impl<T> Default for ThreadLocal<T>

where T: Send,

fn default() -> ThreadLocal<T>

Returns the “default value” for a type.

impl<T> Drop for ThreadLocal<T>

where T: Send,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a, T> IntoIterator for &'a ThreadLocal<T>

where T: Send + Sync,

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a ThreadLocal<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut ThreadLocal<T>

where T: Send,

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<T> IntoIterator for ThreadLocal<T>

where T: Send,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<T> Sync for ThreadLocal<T>

where T: Send,

impl<T> UnwindSafe for ThreadLocal<T>

where T: Send + UnwindSafe,