Struct avr_oxide::util::datatypes::VolatileBitField

#[repr(C)]
pub struct VolatileBitField(/* private fields */);

Helper newtype for a Bitfield that representas a volatile underlying field (I/O register or similar).

Implementations

impl VolatileBitField

pub const fn all_clr() -> Self

pub const fn all_set() -> Self

pub fn snapshot(&self) -> BitField

Return a copy of the underlying volatile value as a non-volatile, copyable-and-clonable BitField.

Trait Implementations

impl BitFieldAccess for VolatileBitField

fn read_byte(&self) -> u8

fn write_byte(&mut self, val: u8)

fn set_isolated<B: BitMaskable>(&mut self, _isotoken: Isolated, bits: B)

Set the bit(s) at the given index/range

fn set<B: BitMaskable + Copy>(&mut self, bits: B)

Set the bit(s) at the given index/range

fn clr_isolated<B: BitMaskable + Copy>(&mut self, _isotoken: Isolated, bits: B)

Clear the bit(s) at the given index/range

fn clr<B: BitMaskable + Copy>(&mut self, bits: B)

Clear the bit at the given index

fn set_or_clr<B: BitMaskable + Copy>(&mut self, bits: B, set: bool)

Set or clear the bit(s) at the given index/range depending on the set parameter (true = set the bit, false = clear it.)

fn set_to<B: BitMaskable + Copy>(&mut self, bits: B, value: u8)

Set the bit(s) at the given index/range to the bitwise value given.

fn set_to_isolated<B: BitMaskable + Copy>( &mut self, _isotoken: Isolated, bits: B, value: u8 )

Set the bit(s) at the given index/range to the bitwise value given.

fn is_set(&self, bit: BitIndex) -> bool

True IFF the bit at the given index is set

fn is_all_set<B: BitMaskable + Copy>(&self, bits: B) -> bool

True IFF all the bits at the given index/range are set

fn is_any_set<B: BitMaskable + Copy>(&self, bits: B) -> bool

True IFF any of the bits at the given index/range are set

fn is_all_clr<B: BitMaskable + Copy>(&self, bits: B) -> bool

True IFF none of the bits at the given index/range are set

fn is_clr(&self, bit: BitIndex) -> bool

True IFF the bit at the given index is clear

fn set_all(&mut self)

Set all bits of the bitmask to 1

fn clr_all(&mut self)

Set all bits of the bitmask to 0

fn exc_set<B: BitMaskable + Copy>(&mut self, bits: B)

Set the bit(s) at the given index/range and clear all others

fn exc_clr<B: BitMaskable + Copy>(&mut self, bits: B)

Clear the bit at the given index and set all others

fn get_val<B: BitMaskable + Copy>(&self, bits: B) -> u8

Return the bit(s) at the given index/range as a binary value.

impl PartialEq for VolatileBitField

fn eq(&self, other: &VolatileBitField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VolatileBitField