Struct voladdress::read_only::ROVolAddress

#[repr(transparent)]
pub struct ROVolAddress<T> { /* fields omitted */ }

As VolAddress, but read only.

Methods

impl<T> ROVolAddress<T>

pub const unsafe fn new(address: usize) -> Self

Constructs a new address.

Safety

You must follow the standard safety rules as outlined in the type docs.

pub const unsafe fn cast<Z>(self) -> ROVolAddress<Z>

Casts the type of T into type Z.

Safety

You must follow the standard safety rules as outlined in the type docs.

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

Offsets the address by offset slots (like pointer::wrapping_offset).

Safety

You must follow the standard safety rules as outlined in the type docs.

pub const fn is_aligned(self) -> bool

Checks that the current target type of this address is aligned at this address value.

pub const fn to_usize(self) -> usize

The usize value of this ROVolAddress.

Important traits for ROVolIter<T>

impl<T> Iterator for ROVolIter<T> type Item = ROVolAddress<T>;

pub const unsafe fn iter_slots(self, slots: usize) -> ROVolIter<T>

Makes an iterator starting here across the given number of slots.

Safety

The normal safety rules must be correct for each address iterated over.

pub fn read(self) -> T where
    T: Copy, 

Volatile reads a Copy value out of the address.

pub unsafe fn read_non_copy(self) -> T

Volatile reads a value out of the address with no trait bound.

Safety

This is not a move, it forms a bit duplicate of the current value at the address. If T has a Drop trait that does anything it is up to you to ensure that repeated drops do not cause UB (such as a double free).

Trait Implementations

impl<T> Clone for ROVolAddress<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> Copy for ROVolAddress<T>

impl<T> PartialEq<ROVolAddress<T>> for ROVolAddress<T>

fn eq(&self, other: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T> Eq for ROVolAddress<T>

impl<T> Ord for ROVolAddress<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<T> PartialOrd<ROVolAddress<T>> for ROVolAddress<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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<T> Debug for ROVolAddress<T>

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

Formats the value using the given formatter.

impl<T> Pointer for ROVolAddress<T>

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

You can request pointer style to get just the inner value with pointer formatting.