Struct voladdress::write_only::WOVolAddress

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

As VolAddress, but write only.

Methods

impl<T> WOVolAddress<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) -> WOVolAddress<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 WOVolAddress.

Important traits for WOVolIter<T>

impl<T> Iterator for WOVolIter<T> type Item = WOVolAddress<T>;

pub const unsafe fn iter_slots(self, slots: usize) -> WOVolIter<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 write(self, val: T)

Volatile writes a value to the address.

Semantically, the value is moved into the function and then forgotten, so if T has a Drop impl then that will never get executed. This is "safe" under Rust's safety rules, but could cause something unintended (eg: a memory leak).

Trait Implementations

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

impl<T> Debug for WOVolAddress<T>

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

Formats the value using the given formatter.

impl<T> Eq for WOVolAddress<T>

impl<T> Ord for WOVolAddress<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.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T> PartialEq<WOVolAddress<T>> for WOVolAddress<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> PartialOrd<WOVolAddress<T>> for WOVolAddress<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> Pointer for WOVolAddress<T>

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

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