Struct Address

pub struct Address<M, T>
where
    M: Mutability,
    T: ?Sized,
{ /* private fields */ }

A generic non-null pointer with type-system mutability tracking.

Type Parameters

• M: The mutability permissions of the source pointer.
• T: The referent type of the source pointer.

Implementations

impl<M, T> Address<M, T>

where M: Mutability,

pub const DANGLING: Self = _

The dangling pointer.

impl<M, T> Address<M, T>

where M: Mutability, T: ?Sized,

pub fn new(addr: NonNull<T>) -> Self

Constructs a new Address over some pointer value.

You are responsible for selecting the correct Mutability marker.

pub fn immut(self) -> Address<Const, T>

Permanently converts an Address<_> into an Address<Const>.

You should generally prefer Address::freeze.

pub unsafe fn assert_mut(self) -> Address<Mut, T>

Force an Address<Const> to be Address<Mut>.

Safety

You should only call this on addresses you know to have been created with Mutable permissions and previously removed by Address::immut.

You should prefer using Address::freeze for temporary, trackable, immutability constraints instead.

pub fn freeze(self) -> Address<Frozen<M>, T>

Freezes the Address so that it is read-only.

pub fn into_inner(self) -> NonNull<T>

Removes the Address type marker, returning the original pointer.

pub fn to_const(self) -> *const T

Gets the address as a read-only pointer.

impl<T> Address<Mut, T>

pub fn to_mut(self) -> *mut T

Gets the address as a write-capable pointer.

impl<M, T> Address<Frozen<M>, T>

where M: Mutability, T: ?Sized,

pub fn thaw(self) -> Address<M, T>

Thaws the Address to its original mutability permission.

impl<M, T> Address<M, T>

where M: Mutability,

Port of the pointer inherent methods on Addresses of Sized types.

pub fn cast<U>(self) -> Address<M, U>

Applies <*T>::cast.

See original documentation.

pub unsafe fn offset(self, count: isize) -> Self

Applies <*T>::offset.

See original documentation.

pub unsafe fn add(self, count: usize) -> Self

Applies <*T>::add.

See original documentation.

pub unsafe fn sub(self, count: usize) -> Self

Applies <*T>::sub.

See original documentation.

pub fn wrapping_offset(self, count: isize) -> Self

Applies <*T>::wrapping_offset.

See original documentation.

pub fn wrapping_add(self, count: usize) -> Self

Applies <*T>::wrapping_add.

See original documentation.

pub fn wrapping_sub(self, count: usize) -> Self

Applies <*T>::wrapping_sub.

See original documentation.

pub unsafe fn offset_from(self, origin: Self) -> isize

Applies <*T>::offset_from.

See original documentation.

pub unsafe fn read(self) -> T

Applies <*T>::read.

See original documentation.

pub unsafe fn read_volatile(self) -> T

Applies <*T>::read_volatile.

See original documentation.

pub unsafe fn read_unaligned(self) -> T

Applies <*T>::read_unaligned.

See original documentation.

pub unsafe fn copy_to(self, dest: Address<Mut, T>, count: usize)

Applies <*T>::copy_to.

See original documentation.

pub unsafe fn copy_to_nonoverlapping(self, dest: Address<Mut, T>, count: usize)

Applies <*T>::copy_to_nonoverlapping.

See original documentation.

pub fn align_offset(self, align: usize) -> usize

Applies <*T>::align_offset.

See original documentation.

impl<M, T> Address<M, T>

where M: Mutability, T: ?Sized,

Port of the pointer inherent methods on Addresses of any type.

pub unsafe fn as_ref<'a>(self) -> Option<&'a T>

Applies <*T>::as_ref.

See original documentation.

impl<T> Address<Mut, T>

Port of pointer inherent methods on mutable Addresses of sized types.

pub unsafe fn copy_from<M2: Mutability>(self, src: Address<M2, T>, count: usize)

Applies <*T>::copy_from.

See original documentation.

pub unsafe fn copy_from_nonoverlapping<M2: Mutability>( self, src: Address<M2, T>, count: usize, )

Applies <*T>::copy_from_nonoverlapping.

See original documentation.

pub unsafe fn write(self, value: T)

Applies <*T>::write.

See original documentation.

pub unsafe fn write_volatile(self, value: T)

Applies <*T>::write_volatile.

See original documentation.

pub unsafe fn write_unaligned(self, value: T)

Applies <*T>::write_unaligned.

See original documentation.

pub unsafe fn replace(self, src: T) -> T

Applies <*T>::replace.

See original documentation.

pub unsafe fn swap(self, with: Self)

Applies <*T>::swap.

See original documentation.

impl<T> Address<Mut, T>

where T: ?Sized,

Port of pointer inherent methods on mutable Addresses of any type.

pub unsafe fn as_mut<'a>(self) -> Option<&'a mut T>

Applies <*T>::as_mut.

See original documentation.

pub unsafe fn drop_in_place(self)

Applies <*T>::drop_in_place.

See original documentation.

Trait Implementations

impl<M, T> Clone for Address<M, T>

where M: Mutability, T: ?Sized,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, T> Debug for Address<M, T>

where M: Mutability, T: ?Sized,

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

Formats the value using the given formatter.

impl<T> From<&T> for Address<Const, T>

where T: ?Sized,

fn from(elem: &T) -> Self

Converts to this type from the input type.

impl<T> From<&mut T> for Address<Mut, T>

where T: ?Sized,

fn from(elem: &mut T) -> Self

Converts to this type from the input type.

impl<M, T> Hash for Address<M, T>

where M: Mutability, T: ?Sized,

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

where H: Hasher,

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<M, T> Ord for Address<M, T>

where M: Mutability,

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<M1, M2, T1, T2> PartialEq<Address<M2, T2>> for Address<M1, T1>

where M1: Mutability, M2: Mutability,

fn eq(&self, other: &Address<M2, T2>) -> 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<M1, M2, T1, T2> PartialOrd<Address<M2, T2>> for Address<M1, T1>

where M1: Mutability, M2: Mutability,

fn partial_cmp(&self, other: &Address<M2, T2>) -> 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<M, T> Pointer for Address<M, T>

where M: Mutability, T: ?Sized,

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

Formats the value using the given formatter.

impl<'a, T> Referential<'a> for Address<Const, T>

where T: 'a + ?Sized,

type Ref = &'a T

The created reference type. Must be one of &T or &mut T.

unsafe fn to_ref(self) -> Self::Ref

Converts the Address to a reference.

fn from_ref(this: Self::Ref) -> Self

Converts a reference back into an Address.

impl<'a, M, T> Referential<'a> for Address<Frozen<M>, T>

where M: Mutability, T: 'a + ?Sized,

type Ref = &'a T

The created reference type. Must be one of &T or &mut T.

unsafe fn to_ref(self) -> Self::Ref

Converts the Address to a reference.

fn from_ref(this: Self::Ref) -> Self

Converts a reference back into an Address.

impl<'a, T> Referential<'a> for Address<Mut, T>

where T: 'a + ?Sized,

type Ref = &'a mut T

The created reference type. Must be one of &T or &mut T.

unsafe fn to_ref(self) -> Self::Ref

Converts the Address to a reference.

fn from_ref(this: Self::Ref) -> Self

Converts a reference back into an Address.

impl<'a, T> SliceReferential<'a> for Address<Const, [T]>

where T: 'a,

type ElementAddr = Address<Const, T>

The type of the element pointer.

unsafe fn from_raw_parts(ptr: Self::ElementAddr, len: usize) -> Self::Ref

Constructs an ordinary slice reference from a base-address and a length.

impl<'a, M, T> SliceReferential<'a> for Address<Frozen<M>, [T]>

where M: Mutability, T: 'a,

type ElementAddr = Address<Frozen<M>, T>

The type of the element pointer.

unsafe fn from_raw_parts(ptr: Self::ElementAddr, len: usize) -> Self::Ref

Constructs an ordinary slice reference from a base-address and a length.

impl<'a, T> SliceReferential<'a> for Address<Mut, [T]>

where T: 'a,

type ElementAddr = Address<Mut, T>

The type of the element pointer.

unsafe fn from_raw_parts(ptr: Self::ElementAddr, len: usize) -> Self::Ref

Constructs an ordinary slice reference from a base-address and a length.

impl<T> TryFrom<*const T> for Address<Const, T>

where T: ?Sized,

type Error = NullPtrError

The type returned in the event of a conversion error.

fn try_from(elem: *const T) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<*mut T> for Address<Mut, T>

where T: ?Sized,

type Error = NullPtrError

The type returned in the event of a conversion error.

fn try_from(elem: *mut T) -> Result<Self, Self::Error>

Performs the conversion.

impl<M, T> Copy for Address<M, T>

where M: Mutability, T: ?Sized,

impl<M, T> Eq for Address<M, T>

where M: Mutability,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.