Struct SyncMutPtr 

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

Wrapped mutable raw pointer that is Send+Sync

Implementations

impl<T> SyncMutPtr<T>

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

Makes ptr Send+Sync

Safety

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

Note: This function is potentially always safe to call, rusts specification does not really make it clear why

pub const fn from_address(addr: usize) -> Self

Returns a SyncMutPtr from an arbitrary address. This is equivalent to casting usize as *mut T

pub fn as_address(&self) -> usize

Returns the address of the pointer. This is equivalent to casting the pointer using *mut T as usize.

Note

Starting with rust 1.84.0, the pointer itself has the functions addr and expose_provenance. These functions should be used instead. They are available via the deref trait. This function is roughly equivalent to the expose_provenance function.

pub const fn null() -> Self

Makes a Send+Sync null ptr.

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

Casts ptr to another data type while keeping it Send+Sync.

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

Returns inner ptr, which is then no longer Send+Sync.

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

Makes ptr immutable.

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

Makes ptr immutable and no longer Sync.

pub const fn as_sync_mut(&self) -> Self

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

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

Makes ptr no longer Sync.

Trait Implementations

impl<T> Clone for SyncMutPtr<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SyncMutPtr<T>

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

Formats the value using the given formatter.

impl<T> Deref for SyncMutPtr<T>

type Target = *mut T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> From<*mut T> for SyncMutPtr<T>

fn from(value: *mut T) -> Self

Converts to this type from the input type.

impl<T> From<SyncMutPtr<T>> for *const T

fn from(val: SyncMutPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<SyncMutPtr<T>> for *mut T

fn from(val: SyncMutPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<SyncMutPtr<T>> for usize

fn from(val: SyncMutPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<usize> for SyncMutPtr<T>

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<T> Hash for SyncMutPtr<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 for SyncMutPtr<T>

fn cmp(&self, other: &Self) -> 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 for SyncMutPtr<T>

fn eq(&self, other: &Self) -> 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 for SyncMutPtr<T>

fn partial_cmp(&self, other: &Self) -> 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> Pointer for SyncMutPtr<T>

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

Formats the value using the given formatter.

impl<T> Copy for SyncMutPtr<T>

impl<T> Eq for SyncMutPtr<T>

impl<T> Send for SyncMutPtr<T>

impl<T> Sync for SyncMutPtr<T>