Expand description
VolatileCell
provides a wrapper around unsafe volatile pointer reads
and writes. This is particularly useful for accessing microcontroller
registers by (unsafely) casting a pointer to the register into a VolatileCell
.
use tock_cells::volatile_cell::VolatileCell;
let myptr: *const usize = 0xdeadbeef as *const usize;
let myregister: &VolatileCell<usize> = unsafe { core::mem::transmute(myptr) };
Implementations
sourceimpl<T> VolatileCell<T> where
T: Copy,
impl<T> VolatileCell<T> where
T: Copy,
pub const fn new(value: T) -> VolatileCell<T>
sourcepub fn set(&self, value: T)
pub fn set(&self, value: T)
Performs a memory write with the provided value.
Side-Effects
set
always performs a memory write on the underlying location. If
this location is a memory-mapped I/O register, the side-effects of
performing the write are register-specific.
Examples
use tock_cells::volatile_cell::VolatileCell;
let vc = VolatileCell::new(123);
vc.set(432);
sourcepub fn get(&self) -> T
pub fn get(&self) -> T
Performs a memory read and returns a copy of the value represented by the cell.
Side-Effects
get
always performs a memory read on the underlying location. If
this location is a memory-mapped I/O register, the side-effects of
performing the read are register-specific.
Examples
use tock_cells::volatile_cell::VolatileCell;
let vc = VolatileCell::new(5);
let five = vc.get();
Trait Implementations
sourceimpl<T> Clone for VolatileCell<T> where
T: Copy,
impl<T> Clone for VolatileCell<T> where
T: Copy,
sourcefn clone(&self) -> VolatileCell<T>
fn clone(&self) -> VolatileCell<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T> Default for VolatileCell<T> where
T: Default + Copy + ?Sized,
impl<T> Default for VolatileCell<T> where
T: Default + Copy + ?Sized,
sourcefn default() -> VolatileCell<T>
fn default() -> VolatileCell<T>
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl<T> !RefUnwindSafe for VolatileCell<T>
impl<T> Send for VolatileCell<T> where
T: Send,
impl<T> !Sync for VolatileCell<T>
impl<T> Unpin for VolatileCell<T> where
T: Unpin,
impl<T> UnwindSafe for VolatileCell<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more