Struct ThreadBound

pub struct ThreadBound<T> { /* private fields */ }

ThreadBound is a Sync-maker and Send-maker that allows accessing a value of type T only from the original thread on which the ThreadBound was constructed.

Refer to the crate-level documentation for a usage example.

Implementations

impl<T> ThreadBound<T>

pub fn new(value: T) -> Self

Binds a value to the current thread. The wrapper can be sent around to other threads, but no other threads will be able to access the underlying value.

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

Accesses a reference to the underlying value if this is its original thread, otherwise None.

pub fn get_mut(&mut self) -> Option<&mut T>

Accesses a mutable reference to the underlying value if this is its original thread, otherwise None.

pub fn into_inner(self) -> Option<T>

Extracts ownership of the underlying value if this is its original thread, otherwise None.

Trait Implementations

impl<T: Debug> Debug for ThreadBound<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ThreadBound<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy> Send for ThreadBound<T>

impl<T> Sync for ThreadBound<T>