Struct SemiSticky

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

A SemiSticky<T> keeps a value T stored in a thread if it has a drop.

This is a combined version of Fragile<T> and Sticky<T>. If the type does not have a drop it will effectively be a Fragile<T>, otherwise it will be internally behave like a Sticky<T>.

Implementations

impl<T> SemiSticky<T>

pub fn new(value: T) -> Self

Creates a new SemiSticky wrapping a value.

The value that is moved into the SemiSticky 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. In case the value does not have Drop it will be stored in the SemiSticky instead.

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 SemiSticky, 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 SemiSticky, 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 SemiSticky is returned as Err(self).

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

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>

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>

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 SemiSticky<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SemiSticky<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for SemiSticky<T>

fn default() -> SemiSticky<T>

Returns the “default value” for a type.

impl<T: Display> Display for SemiSticky<T>

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

Formats the value using the given formatter.

impl<T> From<T> for SemiSticky<T>

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

Converts to this type from the input type.

impl<T: Ord> Ord for SemiSticky<T>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for SemiSticky<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for SemiSticky<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SemiSticky<T>) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SemiSticky<T>) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for SemiSticky<T>