Struct ThreadBound 

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

A value that stays on the thread that created it, inside an object that is shared between threads.

A render resource is shared between the UI thread and the render thread, yet some of them keep a part that only one of the threads uses (the render target a render target bitmap draws itself with, for example). The part is reached through get, which panics on any other thread, so the object as a whole can be Send + Sync.

When the object is dropped on another thread the value is not dropped but leaked: its destructor may only run on its own thread. Owners release what the value holds from their dispose, on the right thread.

Implementations

impl<T> ThreadBound<T>

pub fn new(value: T) -> Self

Binds value to the current thread.

pub fn is_on_thread(&self) -> bool

Whether the current thread is the one the value is bound to.

pub fn get(&self) -> &T

The value.

Panics

On a thread other than the one the value was created on.

pub fn into_inner(self) -> T

Takes the value out.

Panics

On a thread other than the one the value was created on.

Trait Implementations

impl<T> Drop for ThreadBound<T>

fn drop(&mut self)

Executes the destructor for this type.

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.

impl<T> Send for ThreadBound<T>

impl<T> Sync for ThreadBound<T>