Skip to main content

ThreadLocal

Struct ThreadLocal 

Source
pub struct ThreadLocal<T> { /* private fields */ }
Expand description

A thread-local storage slot holding an independent value of type T per thread.

The value for each thread is constructed lazily on first access using the init function supplied at creation time, and dropped when the thread exits.

Implementations§

Source§

impl<T> ThreadLocal<T>

Source

pub fn new(init: fn() -> T) -> Self

Allocates a TLS slot. init is called once per thread to construct its value.

Source

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Calls f with a shared reference to this thread’s value, initializing it on first access.

Source

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

Calls f with a mutable reference to this thread’s value, initializing it on first access.

Trait Implementations§

Source§

impl<T> Drop for ThreadLocal<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for ThreadLocal<T>

§

impl<T> RefUnwindSafe for ThreadLocal<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for ThreadLocal<T>

§

impl<T> UnsafeUnpin for ThreadLocal<T>

§

impl<T> UnwindSafe for ThreadLocal<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.