Struct SendWrapper 

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

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>

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 unsafe fn take_unchecked(self) -> T

Takes the value out of the SendWrapper<T>.

Safety

The caller should be in the same thread as the creator.

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.

pub unsafe fn get_unchecked(&self) -> &T

Returns a reference to the contained value.

Safety

The caller should be in the same thread as the creator.

pub unsafe fn get_unchecked_mut(&mut self) -> &mut T

Returns a mutable reference to the contained value.

Safety

The caller should be in the same thread as the creator.

pub unsafe fn get_unchecked_pinned(self: Pin<&Self>) -> Pin<&T>

Returns a pinned reference to the contained value.

Safety

The caller should be in the same thread as the creator.

pub unsafe fn get_unchecked_pinned_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Returns a pinned mutable reference to the contained value.

Safety

The caller should be in the same thread as the creator.

pub fn get(&self) -> Option<&T>

Returns a reference to the contained value, if valid.

pub fn get_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the contained value, if valid.

pub fn get_pinned(self: Pin<&Self>) -> Option<Pin<&T>>

Returns a pinned reference to the contained value, if valid.

pub fn get_pinned_mut(self: Pin<&mut Self>) -> Option<Pin<&mut T>>

Returns a pinned mutable reference to the contained value, if valid.

pub fn tracker(&self) -> SendWrapper<()>

Returns a tracker that can be used to check if the current thread is the same as the creator thread.

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.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

If the SendWrapper<T> is formatted from a different thread than the one it was created on, the data field is shown as "<invalid>" instead of causing a panic.

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.

impl<T> Send for SendWrapper<T>

impl<T> Sync for SendWrapper<T>