Union volatile_mem::Volatile

#[repr(C)]pub union Volatile<T: Copy, Permission = ReadWrite> {
    // some fields omitted
}

Volatile data or memory.

See crate-level documentation for details.

Implementations

impl<T: Copy, P> Volatile<T, P>

pub unsafe fn from_ptr<'a>(mem: *const T) -> &'a Self

Converts a pointer to T into a reference to Volatile<T>, which can be read-only, write-only, or both readable and writable (the default).

Safety

Behavior is undefined if any of the following conditions are violated:

• mem must be valid for reads and/or writes.

• mem must be properly aligned.

• mem must point to a properly initialized value of type T (unless the resulting Volatile<T> is write-only).

Note that even if T has size zero, the pointer must be non-NULL and properly aligned.

Just like in C, whether an operation is volatile has no bearing whatsoever on questions involving concurrent access from multiple threads. Volatile accesses behave exactly like non-atomic accesses in that regard. In particular, a race between a write operation any other operation (reading or writing) to the same location is undefined behavior.

pub unsafe fn from_mut_ptr<'a>(mem: *mut T) -> &'a mut Self

Converts a mutable pointer to T into a mutable reference to Volatile<T>, which can be read-only, write-only, or both readable and writable (the default).

Safety

Behavior is undefined if any of the following conditions are violated:

• mem must be valid for reads and/or writes.

• mem must be properly aligned.

• mem must point to a properly initialized value of type T (unless the resulting Volatile<T> is write-only).

Note that even if T has size zero, the pointer must be non-NULL and properly aligned.

pub fn from_ref<'a>(mem: &T) -> &'a Self

Converts a shared reference to T into a shared reference to Volatile<T>, which can be read-only, write-only, or both readable and writable (the default).

pub fn from_mut<'a>(mem: &mut T) -> &'a mut Self

Converts a mutable reference to T into a mutable reference to Volatile<T>, which can be read-only, write-only, or both readable and writable (the default).

Trait Implementations

impl<T: Copy, P, const N: usize> AsMut<[Volatile<T, P>]> for Volatile<[T; N], P>

fn as_mut(&mut self) -> &mut [Volatile<T, P>]

Performs the conversion.

impl<T: Copy, P, const N: usize> AsRef<[Volatile<T, P>]> for Volatile<[T; N], P>

fn as_ref(&self) -> &[Volatile<T, P>]

Performs the conversion.

impl<T: Copy, P, const N: usize> Borrow<[Volatile<T, P>]> for Volatile<[T; N], P>

fn borrow(&self) -> &[Volatile<T, P>]

Immutably borrows from an owned value.

impl<T: Copy, P, const N: usize> BorrowMut<[Volatile<T, P>]> for Volatile<[T; N], P>

fn borrow_mut(&mut self) -> &mut [Volatile<T, P>]

Mutably borrows from an owned value.

impl<T: Copy, P> Debug for Volatile<T, P>

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

Formats the value using the given formatter.

impl<T: Copy, P, const N: usize> Deref for Volatile<[T; N], P>

type Target = [Volatile<T, P>]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Copy, P, const N: usize> DerefMut for Volatile<[T; N], P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: Copy, P> From<&'a T> for &'a Volatile<T, P>

fn from(mem: &'a T) -> &'a Volatile<T, P>

Performs the conversion.

impl<'a, T: Copy, P> From<&'a mut T> for &'a mut Volatile<T, P>

fn from(mem: &'a mut T) -> &'a mut Volatile<T, P>

Performs the conversion.

impl<T: Copy, P> VolatileData<T> for Volatile<T, P>

impl<T: Copy, P: Read> VolatileRead<T> for Volatile<T, P>

fn read(&self) -> T

Performs a volatile read of the value in self without moving it. This leaves the memory in self unchanged.

impl<T: Copy, P: Write> VolatileWrite<T> for Volatile<T, P>

fn write(&mut self, val: T)

Performs a volatile write of self with the given value without reading the old value.