Struct fragile::Sticky

pub struct Sticky<T: 'static> { /* private fields */ }

A Sticky<T> keeps a value T stored in a thread.

This type works similar in nature to Fragile and exposes a similar interface. The difference is that whereas Fragile has its destructor called in the thread where the value was sent, a Sticky that is moved to another thread will have the internal destructor called when the originating thread tears down.

Because Sticky allows values to be kept alive for longer than the Sticky itself, it requires all its contents to be 'static for soundness. More importantly it also requires the use of StackTokens. For information about how to use stack tokens and why they are neded, refer to stack_token!.

As this uses TLS internally the general rules about the platform limitations of destructors for TLS apply.

Implementations

impl<T> Sticky<T>

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

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

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>

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<'stack>(&'stack self, _proof: &'stack StackToken) -> &'stack 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<'stack>(
    &'stack mut self,
    _proof: &'stack StackToken
) -> &'stack 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<'stack>(
    &'stack self,
    _proof: &'stack StackToken
) -> Result<&'stack 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<'stack>(
    &'stack mut self,
    _proof: &'stack StackToken
) -> Result<&'stack 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: Clone> Clone for Sticky<T>

fn clone(&self) -> Sticky<T>

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Sticky<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Sticky<T>

fn default() -> Sticky<T>

Returns the “default value” for a type.

impl<T: Display> Display for Sticky<T>

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

Formats the value using the given formatter.

impl<T> Drop for Sticky<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for Sticky<T>

fn from(t: T) -> Sticky<T>

Converts to this type from the input type.

impl<T: Ord> Ord for Sticky<T>

fn cmp(&self, other: &Sticky<T>) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Sticky<T>> for Sticky<T>

fn eq(&self, other: &Sticky<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd<Sticky<T>> for Sticky<T>

fn partial_cmp(&self, other: &Sticky<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Sticky<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

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.

fn gt(&self, other: &Sticky<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

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.

impl<T: Eq> Eq for Sticky<T>

impl<T> Send for Sticky<T>

impl<T> Sync for Sticky<T>