#[repr(transparent)]
pub struct VolatileCell<T> where
    T: Copy + ?Sized
{ /* private fields */ }
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

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

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Returns the “default value” for a type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.