Struct Mode 

pub struct Mode { /* private fields */ }

Implementations

impl Mode

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl Mode

pub const fn into_bytes(self) -> [u8; 4]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 4]) -> Self

Converts the given bytes directly into the bitfield struct.

impl Mode

pub fn char_len(&self) -> <CharLen as Specifier>::InOut

Returns the value of char_len.

pub fn char_len_or_err( &self, ) -> Result<<CharLen as Specifier>::InOut, InvalidBitPattern<<CharLen as Specifier>::Bytes>>

Returns the value of char_len.

#Errors

If the returned value contains an invalid bit pattern for char_len.

pub fn with_char_len(self, new_val: <CharLen as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of char_len set to the given value.

#Panics

If the given value is out of bounds for char_len.

pub fn with_char_len_checked( self, new_val: <CharLen as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of char_len set to the given value.

#Errors

If the given value is out of bounds for char_len.

pub fn set_char_len(&mut self, new_val: <CharLen as Specifier>::InOut)

Sets the value of char_len to the given value.

#Panics

If the given value is out of bounds for char_len.

pub fn set_char_len_checked( &mut self, new_val: <CharLen as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of char_len to the given value.

#Errors

If the given value is out of bounds for char_len.

pub fn parity(&self) -> <Parity as Specifier>::InOut

Returns the value of parity.

pub fn parity_or_err( &self, ) -> Result<<Parity as Specifier>::InOut, InvalidBitPattern<<Parity as Specifier>::Bytes>>

Returns the value of parity.

#Errors

If the returned value contains an invalid bit pattern for parity.

pub fn with_parity(self, new_val: <Parity as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of parity set to the given value.

#Panics

If the given value is out of bounds for parity.

pub fn with_parity_checked( self, new_val: <Parity as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of parity set to the given value.

#Errors

If the given value is out of bounds for parity.

pub fn set_parity(&mut self, new_val: <Parity as Specifier>::InOut)

Sets the value of parity to the given value.

#Panics

If the given value is out of bounds for parity.

pub fn set_parity_checked( &mut self, new_val: <Parity as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of parity to the given value.

#Errors

If the given value is out of bounds for parity.

pub fn n_stop_bits(&self) -> <NumStopBits as Specifier>::InOut

Returns the value of n_stop_bits.

pub fn n_stop_bits_or_err( &self, ) -> Result<<NumStopBits as Specifier>::InOut, InvalidBitPattern<<NumStopBits as Specifier>::Bytes>>

Returns the value of n_stop_bits.

#Errors

If the returned value contains an invalid bit pattern for n_stop_bits.

pub fn with_n_stop_bits( self, new_val: <NumStopBits as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of n_stop_bits set to the given value.

#Panics

If the given value is out of bounds for n_stop_bits.

pub fn with_n_stop_bits_checked( self, new_val: <NumStopBits as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of n_stop_bits set to the given value.

#Errors

If the given value is out of bounds for n_stop_bits.

pub fn set_n_stop_bits(&mut self, new_val: <NumStopBits as Specifier>::InOut)

Sets the value of n_stop_bits to the given value.

#Panics

If the given value is out of bounds for n_stop_bits.

pub fn set_n_stop_bits_checked( &mut self, new_val: <NumStopBits as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of n_stop_bits to the given value.

#Errors

If the given value is out of bounds for n_stop_bits.

Trait Implementations

impl CheckTotalSizeMultipleOf8 for Mode

type Size = TotalSize<[(); 0]>

impl From<Mode> for u32

where [(); 32]: IsU32Compatible,

fn from(__bf_bitfield: Mode) -> Self

Converts to this type from the input type.

impl From<u32> for Mode

where [(); 32]: IsU32Compatible,

fn from(__bf_prim: u32) -> Self

Converts to this type from the input type.