pub struct Sticky<T> { /* private fields */ }
Expand description
A Sticky<T>
keeps a value T stored in a thread.
This type works similar in nature to Fragile<T>
and exposes the
same interface. The difference is that whereas Fragile<T>
has
its destructor called in the thread where the value was sent, a
Sticky<T>
that is moved to another thread will have the internal
destructor called when the originating thread tears down.
As this uses TLS internally the general rules about the platform limitations of destructors for TLS apply.
Implementations
Creates a new Sticky
wrapping a value
.
The value that is moved into the Sticky
can be non Send
and
will be anchored to the thread that created the object. If the
sticky wrapper type ends up being send from thread to thread
only the original thread can interact with the value.
Returns true
if the access is valid.
This will be false
if the value was sent to another thread.
Consumes the Sticky
, returning the wrapped value.
Panics
Panics if called from a different thread than the one where the original value was created.
Consumes the Sticky
, returning the wrapped value if successful.
The wrapped value is returned if this is called from the same thread
as the one where the original value was created, otherwise the
Sticky
is returned as Err(self)
.
Mutably borrows the wrapped value.
Panics
Panics if the calling thread is not the one that wrapped the value.
For a non-panicking variant, use try_get_mut
.
Tries to immutably borrow the wrapped value.
Returns None
if the calling thread is not the one that wrapped the value.
Tries to mutably borrow the wrapped value.
Returns None
if the calling thread is not the one that wrapped the value.
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Sticky<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Sticky<T> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more