Struct ThreadGuard

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

Thread guard that only gives access to the contained value on the thread it was created on.

Implementations

impl<T> ThreadGuard<T>

pub fn new(value: T) -> ThreadGuard<T>

Create a new thread guard around value.

The thread guard ensures that access to the value is only allowed from the thread it was created on, and otherwise panics.

The thread guard implements the Send trait even if the contained value does not.

pub fn get_ref(&self) -> &T

Return a reference to the contained value from the thread guard.

Panics

This function panics if called from a different thread than where the thread guard was created.

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

Return a mutable reference to the contained value from the thread guard.

Panics

This function panics if called from a different thread than where the thread guard was created.

pub fn into_inner(self) -> T

Return the contained value from the thread guard.

Panics

This function panics if called from a different thread than where the thread guard was created.

pub fn is_owner(&self) -> bool

Returns true if the current thread owns the value, i.e. it can be accessed safely.

Trait Implementations

impl<T> Deref for ThreadGuard<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<ThreadGuard<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for ThreadGuard<T>

fn deref_mut(&mut self) -> &mut <ThreadGuard<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Drop for ThreadGuard<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for ThreadGuard<T>

impl<T> Sync for ThreadGuard<T>