Struct Fragile 

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

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 does not panic and instead retains the value until the originating thread exits.

Polling a Fragile as a Future or Stream moves its value to stable heap storage before the first poll. If a polled Fragile with drop glue is dropped on another thread, that storage is leaked to preserve the value’s pinning invariant. A Fragile<T> is Unpin only if T is Unpin.

Implementations

impl<T> Fragile<T>

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.

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 Fragile, 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 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).

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Fragile<T>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<T> Drop for Fragile<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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

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

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

Converts to this type from the input type.

impl<F: Future> Future for Fragile<F>

type Output = <F as Future>::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

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

fn cmp(&self, other: &Fragile<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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

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

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

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

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

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

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

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

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

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

impl<T> Send for Fragile<T>

impl<S: Stream> Stream for Fragile<S>

type Item = <S as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<T> Sync for Fragile<T>