Struct wayland_commons::ThreadGuard

pub struct ThreadGuard<T: ?Sized> {
    pub(crate) thread: ThreadId,
    pub(crate) val: ManuallyDrop<T>,
}

Stores a value in a threadafe container that only lets you access it from its owning thread

If the ThreadGuard is dropped from the wrong thread, the underlying value will be leaked.

Fields

thread: ThreadId

val: ManuallyDrop<T>

Implementations

impl<T> ThreadGuard<T>

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

Create a new ThreadGuard wrapper

impl<T: ?Sized> ThreadGuard<T>

pub fn get(&self) -> &T

Access the underlying value

Panics if done on the wrong thread

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

Mutably access the underlying value

Panics if done on the wrong thread

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

Try to access the underlying value

Returns None if done on the wrong thread

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

Try to mutably access the underlying value

Returns None if done on the wrong thread

Trait Implementations

impl<T: Debug + ?Sized> Debug for ThreadGuard<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for ThreadGuard<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized> Send for ThreadGuard<T>

impl<T: ?Sized> Sync for ThreadGuard<T>