Struct wyz::comu::Address

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

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§

source§

impl<M, T> Address<M, T>
where M: Mutability,

source

pub const DANGLING: Self = _

The dangling pointer.

source§

impl<M, T> Address<M, T>
where M: Mutability, T: ?Sized,

source

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

Constructs a new Address over some pointer value.

You are responsible for selecting the correct Mutability marker.

source

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

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

You should generally prefer Address::freeze.

source

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.

source

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

Freezes the Address so that it is read-only.

source

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

Removes the Address type marker, returning the original pointer.

source

pub fn to_const(self) -> *const T

Gets the address as a read-only pointer.

source§

impl<T> Address<Mut, T>

source

pub fn to_mut(self) -> *mut T

Gets the address as a write-capable pointer.

source§

impl<M, T> Address<Frozen<M>, T>
where M: Mutability, T: ?Sized,

source

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

Thaws the Address to its original mutability permission.

source§

impl<M, T> Address<M, T>
where M: Mutability,

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

source

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

Applies <*T>::cast.

See original documentation.

source

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

Applies <*T>::offset.

See original documentation.

source

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

Applies <*T>::add.

See original documentation.

source

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

Applies <*T>::sub.

See original documentation.

source

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

Applies <*T>::wrapping_offset.

See original documentation.

source

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

Applies <*T>::wrapping_add.

See original documentation.

source

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

Applies <*T>::wrapping_sub.

See original documentation.

source

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

Applies <*T>::offset_from.

See original documentation.

source

pub unsafe fn read(self) -> T

Applies <*T>::read.

See original documentation.

source

pub unsafe fn read_volatile(self) -> T

Applies <*T>::read_volatile.

See original documentation.

source

pub unsafe fn read_unaligned(self) -> T

Applies <*T>::read_unaligned.

See original documentation.

source

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

Applies <*T>::copy_to.

See original documentation.

source

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

Applies <*T>::copy_to_nonoverlapping.

See original documentation.

source

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

Applies <*T>::align_offset.

See original documentation.

source§

impl<M, T> Address<M, T>
where M: Mutability, T: ?Sized,

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

source

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

Applies <*T>::as_ref.

See original documentation.

source§

impl<T> Address<Mut, T>

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

source

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

Applies <*T>::copy_from.

See original documentation.

source

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

Applies <*T>::copy_from_nonoverlapping.

See original documentation.

source

pub unsafe fn write(self, value: T)

Applies <*T>::write.

See original documentation.

source

pub unsafe fn write_volatile(self, value: T)

Applies <*T>::write_volatile.

See original documentation.

source

pub unsafe fn write_unaligned(self, value: T)

Applies <*T>::write_unaligned.

See original documentation.

source

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

Applies <*T>::replace.

See original documentation.

source

pub unsafe fn swap(self, with: Self)

Applies <*T>::swap.

See original documentation.

source§

impl<T> Address<Mut, T>
where T: ?Sized,

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

source

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

Applies <*T>::as_mut.

See original documentation.

source

pub unsafe fn drop_in_place(self)

Applies <*T>::drop_in_place.

See original documentation.

Trait Implementations§

source§

impl<M, T> Clone for Address<M, T>
where M: Mutability, T: ?Sized,

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<M, T> Debug for Address<M, T>
where M: Mutability, T: ?Sized,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> From<&T> for Address<Const, T>
where T: ?Sized,

source§

fn from(elem: &T) -> Self

Converts to this type from the input type.
source§

impl<T> From<&mut T> for Address<Mut, T>
where T: ?Sized,

source§

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

Converts to this type from the input type.
source§

impl<M, T> Hash for Address<M, T>
where M: Mutability, T: ?Sized,

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<M, T> Ord for Address<M, T>
where M: Mutability,

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<M1, M2, T1, T2> PartialEq<Address<M2, T2>> for Address<M1, T1>
where M1: Mutability, M2: Mutability,

source§

fn eq(&self, other: &Address<M2, T2>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<M1, M2, T1, T2> PartialOrd<Address<M2, T2>> for Address<M1, T1>
where M1: Mutability, M2: Mutability,

source§

fn partial_cmp(&self, other: &Address<M2, T2>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<M, T> Pointer for Address<M, T>
where M: Mutability, T: ?Sized,

source§

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

Formats the value using the given formatter. Read more
source§

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.
source§

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

Converts the Address to a reference. Read more
source§

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

Converts a reference back into an Address.
source§

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.
source§

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

Converts the Address to a reference. Read more
source§

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

Converts a reference back into an Address.
source§

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.
source§

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

Converts the Address to a reference. Read more
source§

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

Converts a reference back into an Address.
source§

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

§

type ElementAddr = Address<Const, T>

The type of the element pointer.
source§

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

Constructs an ordinary slice reference from a base-address and a length. Read more
source§

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.
source§

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

Constructs an ordinary slice reference from a base-address and a length. Read more
source§

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

§

type ElementAddr = Address<Mut, T>

The type of the element pointer.
source§

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

Constructs an ordinary slice reference from a base-address and a length. Read more
source§

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.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<M, T> Copy for Address<M, T>
where M: Mutability, T: ?Sized,

source§

impl<M, T> Eq for Address<M, T>
where M: Mutability,

Auto Trait Implementations§

§

impl<M, T> Freeze for Address<M, T>
where M: Freeze, T: ?Sized,

§

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

§

impl<M, T> !Send for Address<M, T>

§

impl<M, T> !Sync for Address<M, T>

§

impl<M, T> Unpin for Address<M, T>
where M: Unpin, T: ?Sized,

§

impl<M, T> UnwindSafe for Address<M, T>
where M: UnwindSafe, T: RefUnwindSafe + ?Sized,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> Conv for T

source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> FmtForward for T

source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
source§

fn fmt_list(self) -> FmtList<Self>
where for<'a> &'a Self: IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pipe for T
where T: ?Sized,

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.