Struct bitvec::ptr::Address

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

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

The dangling pointer.

pub fn new(addr: NonNull<T>) -> Address<M, T>

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 unsafe fn offset(self, count: isize) -> Address<M, T>

Applies <*T>::offset.

Panics

This panics if the result of applying the offset is the null pointer.

Safety

See pointer::offset.

pub fn wrapping_offset(self, count: isize) -> Address<M, T>

Applies <*T>::wrapping_offset.

Panics

This panics if the result of applying the offset is the null pointer.

pub fn to_const(self) -> *const T

Gets the address as a read-only pointer.

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

Changes the referent type of the 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, 

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

Thaws the Address to its original mutability permission.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

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

pub fn from(elem: &T) -> Address<Const, T>

Performs the conversion.

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

pub fn from(elem: &mut T) -> Address<Mut, T>

Performs the conversion.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

pub fn cmp(&self, other: &Address<M, T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

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, 

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

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

#[must_use]

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

This method tests for !=.

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

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method 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, 

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

Formats the value using the given formatter.

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

type Error = NullPtrError

The type returned in the event of a conversion error.

pub fn try_from(
    elem: *const T
) -> Result<Address<Const, T>, <Address<Const, T> as TryFrom<*const T>>::Error>

Performs the conversion.

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

type Error = NullPtrError

The type returned in the event of a conversion error.

pub fn try_from(
    elem: *mut T
) -> Result<Address<Mut, T>, <Address<Mut, T> as TryFrom<*mut T>>::Error>

Performs the conversion.