Struct fragile::Sticky [−][src]
pub struct Sticky<T> { /* fields omitted */ }
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.
Methods
impl<T> Sticky<T>
[src]
impl<T> Sticky<T>
pub fn new(value: T) -> Self
[src]
pub fn new(value: T) -> Self
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.
pub fn is_valid(&self) -> bool
[src]
pub fn is_valid(&self) -> bool
Returns true
if the access is valid.
This will be false
if the value was sent to another thread.
pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
Consumes the Sticky
, returning the wrapped value.
Panics
Panics if called from a different thread than the one where the original value was created.
pub fn try_into_inner(self) -> Result<T, Self>
[src]
pub fn try_into_inner(self) -> Result<T, Self>
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)
.
pub fn get(&self) -> &T
[src]
pub fn get(&self) -> &T
Immutably 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
.
pub fn get_mut(&mut self) -> &mut T
[src]
pub fn get_mut(&mut self) -> &mut T
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
.
pub fn try_get(&self) -> Result<&T, InvalidThreadAccess>
[src]
pub fn try_get(&self) -> Result<&T, InvalidThreadAccess>
Tries to immutably borrow the wrapped value.
Returns None
if the calling thread is not the one that wrapped the value.
pub fn try_get_mut(&mut self) -> Result<&mut T, InvalidThreadAccess>
[src]
pub fn try_get_mut(&mut self) -> Result<&mut T, InvalidThreadAccess>
Tries to mutably borrow the wrapped value.
Returns None
if the calling thread is not the one that wrapped the value.
Trait Implementations
impl<T> Drop for Sticky<T>
[src]
impl<T> Drop for Sticky<T>
impl<T> From<T> for Sticky<T>
[src]
impl<T> From<T> for Sticky<T>
impl<T: Clone> Clone for Sticky<T>
[src]
impl<T: Clone> Clone for Sticky<T>
fn clone(&self) -> Sticky<T>
[src]
fn clone(&self) -> Sticky<T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<T: Default> Default for Sticky<T>
[src]
impl<T: Default> Default for Sticky<T>
impl<T: PartialEq> PartialEq for Sticky<T>
[src]
impl<T: PartialEq> PartialEq for Sticky<T>
fn eq(&self, other: &Sticky<T>) -> bool
[src]
fn eq(&self, other: &Sticky<T>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<T: Eq> Eq for Sticky<T>
[src]
impl<T: Eq> Eq for Sticky<T>
impl<T: PartialOrd> PartialOrd for Sticky<T>
[src]
impl<T: PartialOrd> PartialOrd for Sticky<T>
fn partial_cmp(&self, other: &Sticky<T>) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Sticky<T>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Sticky<T>) -> bool
[src]
fn lt(&self, other: &Sticky<T>) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Sticky<T>) -> bool
[src]
fn le(&self, other: &Sticky<T>) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Sticky<T>) -> bool
[src]
fn gt(&self, other: &Sticky<T>) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Sticky<T>) -> bool
[src]
fn ge(&self, other: &Sticky<T>) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<T: Ord> Ord for Sticky<T>
[src]
impl<T: Ord> Ord for Sticky<T>
fn cmp(&self, other: &Sticky<T>) -> Ordering
[src]
fn cmp(&self, other: &Sticky<T>) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl<T: Display> Display for Sticky<T>
[src]
impl<T: Display> Display for Sticky<T>
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<T: Debug> Debug for Sticky<T>
[src]
impl<T: Debug> Debug for Sticky<T>
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<T> Sync for Sticky<T>
[src]
impl<T> Sync for Sticky<T>
impl<T> Send for Sticky<T>
[src]
impl<T> Send for Sticky<T>