Struct volatile::ReadOnly

pub struct ReadOnly<T: Copy>(_);

A volatile wrapper which only allows read operations.

The size of this struct is the same as the contained type.

Implementations

impl<T: Copy> ReadOnly<T>

pub fn new(value: T) -> ReadOnly<T>

Construct a new read-only volatile wrapper wrapping the given value.

use volatile::ReadOnly;

let value = ReadOnly::new(42u32);

Panics

This function never panics.

pub fn read(&self) -> T

Perform a volatile read of the contained value, returning a copy of the read value. Functionally equivalent to Volatile::read.

use volatile::ReadOnly;

let value = ReadOnly::new(42u32);
assert_eq!(value.read(), 42u32);

Panics

This function never panics.

Trait Implementations

impl<T: Clone + Copy> Clone for ReadOnly<T>

fn clone(&self) -> ReadOnly<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Copy> Debug for ReadOnly<T>

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

Formats the value using the given formatter.

impl<T: Default + Copy> Default for ReadOnly<T>

fn default() -> ReadOnly<T>

Returns the “default value” for a type.