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

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

Implementations§

source§

impl<T> ThreadGuard<T>

source

pub fn new(value: T) -> Self

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.

source

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.

source

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.

source

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.

source

pub fn is_owner(&self) -> bool

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

Trait Implementations§

source§

impl<T> Drop for ThreadGuard<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> Send for ThreadGuard<T>

Auto Trait Implementations§

§

impl<T> Freeze for ThreadGuard<T>
where T: Freeze,

§

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

§

impl<T> Sync for ThreadGuard<T>
where T: Sync,

§

impl<T> Unpin for ThreadGuard<T>
where T: Unpin,

§

impl<T> UnwindSafe for ThreadGuard<T>
where T: UnwindSafe,

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>,

§

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>,

§

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.