Struct sync_ptr::SendConstPtr

pub struct SendConstPtr<T>(/* private fields */);

Wrapped const raw pointer that is Send but not Sync

Implementations

impl<T> SendConstPtr<T>

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

Makes ptr Send

Safety

The ptr parameter must be able to handle being sent to other threads or special care must be taken when using the wrapped ptr to not use it in any way in other threads.

pub const fn null() -> Self

Makes a Send null ptr.

pub const fn cast<Y>(&self) -> SendConstPtr<Y>

Casts ptr to another data type while keeping it Send.

pub const fn inner(&self) -> *const T

Returns inner ptr which is then no longer Send.

pub const unsafe fn as_sync_const(&self) -> SyncConstPtr<T>

Makes this ptr Sync

Safety

This ptr must be able to handle being accessed by multiple threads at the same time, or special care must be taken when using the wrapped ptr to not use it in any way in other threads.

pub const fn as_send_const(&self) -> SendConstPtr<T>

This is equivalent to .clone() and does nothing.

pub const unsafe fn as_sync_mut(&self) -> SyncMutPtr<T>

Makes this ptr Sync

Safety

This ptr must be able to handle being accessed by multiple threads at the same time, or special care must be taken when using the wrapped ptr to not use it in any way in other threads.

ptr is also marked as mutable. Writing to immutable data is usually UB.

pub const fn as_send_mut(&self) -> SendMutPtr<T>

Makes this ptr mutable

Safety

Writing to immutable data is UB.

Trait Implementations

impl<T> Clone for SendConstPtr<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SendConstPtr<T>

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

Formats the value using the given formatter.

impl<T> Deref for SendConstPtr<T>

type Target = *const T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Hash> Hash for SendConstPtr<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> Into<*const T> for SendConstPtr<T>

fn into(self) -> *const T

Converts this type into the (usually inferred) input type.

impl<T: Ord> Ord for SendConstPtr<T>

fn cmp(&self, other: &SendConstPtr<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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for SendConstPtr<T>

fn eq(&self, other: &SendConstPtr<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> PartialOrd for SendConstPtr<T>

fn partial_cmp(&self, other: &SendConstPtr<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 for SendConstPtr<T>

impl<T: Eq> Eq for SendConstPtr<T>

impl<T> Send for SendConstPtr<T>

impl<T> StructuralPartialEq for SendConstPtr<T>