Struct UnsafeSend 

pub struct UnsafeSend<T: ?Sized>(/* private fields */);

A wrapper that unsafely makes T Send without requiring it for T.

Construction of this type is unsafe, as the caller must ensure that every use of the resulting value is indeed thread-safe. Do not expose instances of this type to safe code!

This is a #[repr(transparent)] wrapper around T, so it has the same memory layout as T. Transmuting between this type and T is valid, but you must uphold the safety requirements for UnsafeSend::new.

Implementations

impl<T> UnsafeSend<T>

pub const unsafe fn new(value: T) -> Self

Creates a new UnsafeSend<T> wrapping the given value.

Safety

Creating UnsafeSend<T> requires unsafe for construction only. The caller must ensure that every use of the resulting value is thread-safe; later uses are not marked unsafe. Do not expose instances of this type to safe code!

pub const fn safe_new(value: T) -> Self

where T: Send,

A safe alternative to construct UnsafeSend<T> when T already implements the required traits.

pub const fn into_inner(this: Self) -> T

Consumes the UnsafeSend<T> and returns the inner value.

impl<T: ?Sized> UnsafeSend<T>

pub const fn inner_ref(this: &Self) -> &T

Returns a reference to the inner value of the UnsafeSend<T>.

This is a const alternative to dereferencing the wrapper.

pub const fn inner_mut(this: &mut Self) -> &mut T

Returns a mutable reference to the inner value of the UnsafeSend<T>.

This is a const alternative to dereferencing the wrapper.

pub const unsafe fn from_ref(value: &T) -> &Self

Maps &T to &UnsafeSend<T>.

This is useful if you receive a reference to a value that you know will be used in a thread-safe manner.

Safety

See UnsafeSend<T>::new.

pub const fn safe_from_ref(value: &T) -> &Self

where T: Send,

A safe alternative to UnsafeSend<T>::from_ref when T already implements the required traits.

pub const unsafe fn from_mut(value: &mut T) -> &mut Self

Maps &mut T to &mut UnsafeSend<T>.

This is useful if you receive a mutable reference to a value that you know will be used in a thread-safe manner.

Safety

See UnsafeSend<T>::new.

pub const fn safe_from_mut(value: &mut T) -> &mut Self

where T: Send,

A safe alternative to UnsafeSend<T>::from_mut when T already implements the required traits.

Trait Implementations

impl<T: Clone + ?Sized> Clone for UnsafeSend<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for UnsafeSend<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for UnsafeSend<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized> DerefMut for UnsafeSend<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Hash + ?Sized> Hash for UnsafeSend<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + ?Sized> Ord for UnsafeSend<T>

fn cmp(&self, other: &UnsafeSend<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 + ?Sized> PartialEq for UnsafeSend<T>

fn eq(&self, other: &UnsafeSend<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 + ?Sized> PartialOrd for UnsafeSend<T>

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

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

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

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

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

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

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

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

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

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

impl<T: Copy + ?Sized> Copy for UnsafeSend<T>

impl<T: Eq + ?Sized> Eq for UnsafeSend<T>

impl<T: ?Sized> Send for UnsafeSend<T>

The wrapper forces the unsafe implementation for T.

impl<T: ?Sized> StructuralPartialEq for UnsafeSend<T>