Struct send_wrapper::SendWrapper

source · [−]

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

Expand description

A wrapper which allows you to move around non-Send-types between threads, as long as you access the contained value only from within the original thread and make sure that it is dropped from within the original thread.

Implementations

impl<T> SendWrapper<T>

pub fn new(data: T) -> SendWrapper<T>ⓘNotable traits for SendWrapper<F>`impl<F: Future> Future for SendWrapper<F> type Output = F::Output;`

Create a SendWrapper<T> wrapper around a value of type T. The wrapper takes ownership of the value.

pub fn valid(&self) -> bool

Returns true if the value can be safely accessed from within the current thread.

pub fn take(self) -> T

Takes the value out of the SendWrapper<T>.

Panics

Panics if it is called from a different thread than the one the SendWrapper<T> instance has been created with.

Trait Implementations

impl<T: Clone> Clone for SendWrapper<T>

fn clone(&self) -> Self

Returns a copy of the value.

Panics

Cloning panics if it is done from a different thread than the one the SendWrapper<T> instance has been created with.

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for SendWrapper<T>

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

Formats the value using the given formatter.

Panics

Formatting panics if it is done from a different thread than the one the SendWrapper<T> instance has been created with.

impl<T> Deref for SendWrapper<T>

fn deref(&self) -> &T

Returns a reference to the contained value.

Panics

Dereferencing panics if it is done from a different thread than the one the SendWrapper<T> instance has been created with.

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for SendWrapper<T>

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

Returns a mutable reference to the contained value.

Panics

Dereferencing panics if it is done from a different thread than the one the SendWrapper<T> instance has been created with.

impl<T> Drop for SendWrapper<T>

fn drop(&mut self)

Drops the contained value.

Panics

Dropping panics if it is done from a different thread than the one the SendWrapper<T> instance has been created with.

Exceptions:

There is no extra panic if the thread is already panicking/unwinding. This is because otherwise there would be double panics (usually resulting in an abort) when dereferencing from a wrong thread.
If T has a trivial drop (needs_drop::<T>() is false) then this method never panics.

impl<F: Future> Future for SendWrapper<F>

Available on crate feature futures only.

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

Polls this SendWrapper Future.

Panics

Polling panics if it is done from a different thread than the one the SendWrapper instance has been created with.

type Output = <F as Future>::Output

The type of value produced on completion.

impl<S: Stream> Stream for SendWrapper<S>

Available on crate feature futures only.

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

Polls this SendWrapper Stream.

Panics

Polling panics if it is done from a different thread than the one the SendWrapper instance has been created with.

type Item = <S as Stream>::Item

Values yielded by the stream.

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

Returns the bounds on the remaining length of the stream. Read more

impl<T> Send for SendWrapper<T>

impl<T> Sync for SendWrapper<T>

Auto Trait Implementations

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
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.

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type IntoFuture = F

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

Which kind of future are we turning this into?

fn into_future(self) -> <F as IntoFuture>::IntoFuture

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

Creates a future from a value.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, U> TryFrom<U> for T where
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.

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<T, U> TryInto<U> for T where
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.

impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more