Struct kernel::utilities::cells::VolatileCell

source ·
pub struct VolatileCell<T> { /* 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§

source§

impl<T> VolatileCell<T>

source

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

Creates a new VolatileCell containing the given value

source

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

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§

source§

impl<T> Default for VolatileCell<T>
where T: Default,

source§

fn default() -> VolatileCell<T>

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

Auto Trait Implementations§

§

impl<T> !Freeze for VolatileCell<T>

§

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§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> SizedTypeProperties for T

source§

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.