Struct VolatileCell

pub struct VolatileCell<T> { /* private fields */ }

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

impl<T> VolatileCell<T>

pub const fn new(value: T) -> VolatileCell<T>

Creates a new VolatileCell containing the given value

pub fn get(&self) -> T

where T: Copy,

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();

pub fn set(&self, value: T)

where T: Copy,

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);

Trait Implementations

impl<T> Default for VolatileCell<T>

where T: Default,

fn default() -> VolatileCell<T>

Returns the “default value” for a type.