Struct TxReady 

pub struct TxReady { /* private fields */ }

Implementations

impl TxReady

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl TxReady

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

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; 2]) -> Self

Converts the given bytes directly into the bitfield struct.

impl TxReady

pub fn en(&self) -> <bool as Specifier>::InOut

Returns the value of en.

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

Returns the value of en.

#Errors

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

pub fn with_en(self, new_val: <bool as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for en.

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

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

#Errors

If the given value is out of bounds for en.

pub fn set_en(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of en to the given value.

#Panics

If the given value is out of bounds for en.

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

Sets the value of en to the given value.

#Errors

If the given value is out of bounds for en.

pub fn pol(&self) -> <Polarity as Specifier>::InOut

Returns the value of pol.

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

Returns the value of pol.

#Errors

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

pub fn with_pol(self, new_val: <Polarity as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for pol.

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

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

#Errors

If the given value is out of bounds for pol.

pub fn set_pol(&mut self, new_val: <Polarity as Specifier>::InOut)

Sets the value of pol to the given value.

#Panics

If the given value is out of bounds for pol.

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

Sets the value of pol to the given value.

#Errors

If the given value is out of bounds for pol.

pub fn pin(&self) -> <B5 as Specifier>::InOut

Returns the value of pin.

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

Returns the value of pin.

#Errors

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

pub fn with_pin(self, new_val: <B5 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for pin.

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

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

#Errors

If the given value is out of bounds for pin.

pub fn set_pin(&mut self, new_val: <B5 as Specifier>::InOut)

Sets the value of pin to the given value.

#Panics

If the given value is out of bounds for pin.

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

Sets the value of pin to the given value.

#Errors

If the given value is out of bounds for pin.

pub fn thres(&self) -> <B9 as Specifier>::InOut

Returns the value of thres.

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

Returns the value of thres.

#Errors

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

pub fn with_thres(self, new_val: <B9 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for thres.

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

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

#Errors

If the given value is out of bounds for thres.

pub fn set_thres(&mut self, new_val: <B9 as Specifier>::InOut)

Sets the value of thres to the given value.

#Panics

If the given value is out of bounds for thres.

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

Sets the value of thres to the given value.

#Errors

If the given value is out of bounds for thres.

Trait Implementations

impl CheckTotalSizeMultipleOf8 for TxReady

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

impl From<TxReady> for u16

where [(); 16]: IsU16Compatible,

fn from(__bf_bitfield: TxReady) -> Self

Converts to this type from the input type.

impl From<u16> for TxReady

where [(); 16]: IsU16Compatible,

fn from(__bf_prim: u16) -> Self

Converts to this type from the input type.