Struct thread_local::ThreadLocal

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

Thread-local variable wrapper

See the module-level documentation for more.

Methods

impl<T: Send> ThreadLocal<T>

pub fn new() -> ThreadLocal<T>

Creates a new empty ThreadLocal.

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.

Important traits for IterMut<'a, T>

impl<'a, T: Send + 'a> Iterator for IterMut<'a, T> type Item = &'a mut T;

pub fn iter_mut(&mut self) -> IterMut<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> ThreadLocal<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 ThreadLocal<T>

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

Formats the value using the given formatter.

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

fn default() -> ThreadLocal<T>

Returns the "default value" for a type.

impl<T: Send> Drop for ThreadLocal<T>

fn drop(&mut self)

Executes the destructor for this type.

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

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

Important traits for IntoIter<T>

impl<T: Send> Iterator for IntoIter<T> type Item = T;

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

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

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?

Important traits for IterMut<'a, T>

impl<'a, T: Send + 'a> Iterator for IterMut<'a, T> type Item = &'a mut T;

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

Creates an iterator from a value.

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

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