Struct VolBox

pub struct VolBox<T, R, W> { /* private fields */ }

An owned memory location for volatile reads and writes.

Implementations

impl<T, R, W> VolBox<T, R, W>

pub const unsafe fn new(loc: *mut T) -> Self

Acquire ownership of a memory location.

If either R or W are Warn, this volatile box should document the additional safety requirements for Self::read/Self::read_at and Self::write/Self::write_at respectively.

Safety

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

• loc must not be aliased by any reference or read/written thru any aliased pointer.
• loc must be valid for reads if R is not Deny.
• loc must be valid for writes if W is not Deny.
• loc must be properly aligned.
• loc must point to a properly initialized value of type T if R is not Deny.

pub fn into_raw(self) -> *mut T

Release ownership of the memory location.

impl<T: Copy, W> VolBox<T, Warn, W>

pub unsafe fn read(&self) -> T

Performs a volatile read on the owned memory location.

Safety

Please consult the documentation on self.

impl<T: Copy, W> VolBox<T, Allow, W>

pub fn read(&self) -> T

Performs a volatile read on the owned memory location.

impl<T: Copy, R> VolBox<T, R, Warn>

pub unsafe fn write(&mut self, t: T)

Performs a volatile write on the owned memory location.

Safety

Please consult the documentation on self.

impl<T: Copy, R> VolBox<T, R, Allow>

pub fn write(&mut self, t: T)

Performs a volatile write on the owned memory location.

impl<T: Copy, W, const N: usize> VolBox<[T; N], Warn, W>

pub unsafe fn read_at(&self, i: usize) -> T

Performs a volatile read on the owned memory location at a specific index.

Panics

Panics if the index is out of bounds.

Safety

Please consult the documentation on self.

impl<T: Copy, W, const N: usize> VolBox<[T; N], Allow, W>

pub fn read_at(&self, i: usize) -> T

Performs a volatile read on the owned memory location at a specific index.

Panics

Panics if the index is out of bounds.

impl<T: Copy, R, const N: usize> VolBox<[T; N], R, Warn>

pub unsafe fn write_at(&mut self, i: usize, t: T)

Performs a volatile write on the owned memory location at a specific index.

Panics

Panics if the index is out of bounds.

Safety

Please consult the documentation on self.

impl<T: Copy, R, const N: usize> VolBox<[T; N], R, Allow>

pub fn write_at(&mut self, i: usize, t: T)

Performs a volatile write on the owned memory location at a specific index.

Safety

Please consult the documentation on self.

Trait Implementations

impl<T: Debug, R: Debug, W: Debug> Debug for VolBox<T, R, W>

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

Formats the value using the given formatter.

impl<T, R, W> Pointer for VolBox<T, R, W>

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

Formats the value using the given formatter.

impl<T: Send, R, W> Send for VolBox<T, R, W>

impl<T: Sync, R, W> Sync for VolBox<T, R, W>