Struct fragile::Fragile

source ·
pub struct Fragile<T> { /* private fields */ }
Expand description

A Fragile<T> wraps a non sendable T to be safely send to other threads.

Once the value has been wrapped it can be sent to other threads but access to the value on those threads will fail.

If the value needs destruction and the fragile wrapper is on another thread the destructor will panic. Alternatively you can use Sticky which is not going to panic but might temporarily leak the value.

Implementations§

source§

impl<T> Fragile<T>

source

pub fn new(value: T) -> Self

Creates a new Fragile wrapping a value.

The value that is moved into the Fragile can be non Send and will be anchored to the thread that created the object. If the fragile wrapper type ends up being send from thread to thread only the original thread can interact with the value.

source

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.

source

pub fn into_inner(self) -> T

Consumes the Fragile, returning the wrapped value.

Panics

Panics if called from a different thread than the one where the original value was created.

source

pub fn try_into_inner(self) -> Result<T, Self>

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

source

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.

source

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.

source

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.

source

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§

source§

impl<T: Clone> Clone for Fragile<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for Fragile<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Default> Default for Fragile<T>

source§

fn default() -> Fragile<T>

Returns the “default value” for a type. Read more
source§

impl<T: Display> Display for Fragile<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Drop for Fragile<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> From<T> for Fragile<T>

source§

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

Converts to this type from the input type.
source§

impl<T: Ord> Ord for Fragile<T>

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl<T: PartialEq> PartialEq<Fragile<T>> for Fragile<T>

source§

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

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

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.
source§

impl<T: PartialOrd> PartialOrd<Fragile<T>> for Fragile<T>

source§

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

This method returns an ordering between self and other values if one exists. Read more
source§

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

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

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
source§

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

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

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<T: Eq> Eq for Fragile<T>

source§

impl<T> Send for Fragile<T>

source§

impl<T> Sync for Fragile<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Fragile<T>where T: RefUnwindSafe,

§

impl<T> Unpin for Fragile<T>where T: Unpin,

§

impl<T> UnwindSafe for Fragile<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

const: unstable · source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.