Struct tmc2209::ReadResponse

#[repr(C)]
pub struct ReadResponse(_);

The read access response datagram.

Implementations

impl ReadResponse

pub const LEN_BYTES: usize

The length of the message in bytes.

pub const SYNC_AND_RESERVED_IX: usize

The first byte is the synchronisation byte.

pub const MASTER_ADDR_IX: usize

The index of the master address byte.

pub const REG_ADDR_IX: usize

The index of the register address.

pub const DATA_RANGE: Range<usize>

The range of byte representing the data field.

pub const CRC_IX: usize

The index of the cyclic rendundency check.

pub fn master_addr(&self) -> u8

The master address.

Should always be 0b11111111.

pub fn reg_addr(&self) -> Result<Address, UnknownAddress>

Read the register address field.

Returns an Err if the value does not correspond with any known register.

pub fn reg_state(&self) -> Result<State, UnknownAddress>

Produce the register state stored within the resonse.

The specific state is determined by first checking the register address.

pub fn data(&self) -> &[u8]

The data slice.

pub fn data_u32(&self) -> u32

The bytes of the data slice shifted into a u32 value.

The u32 can be converted directly into the Register type associated with the reg::Address. See the register method.

pub fn register<R>(&self) -> Result<R, UnknownAddress> where
    R: ReadableRegister, 

Attempt to cast the data field to a register bitfield of the given type.

Uses the data_u32 method internally.

pub fn crc_is_valid(&self) -> bool

Returns true if the CRC is valid, false otherwise.

pub fn bytes(&self) -> &[u8; 8]

The inner slice of bytes.

Trait Implementations

impl Clone for ReadResponse

fn clone(&self) -> ReadResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReadResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for ReadResponse

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Hash for ReadResponse

fn hash<H: Hasher>(&self, _h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ReadResponse> for ReadResponse

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

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

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

This method tests for !=.

impl Serialize for ReadResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl uDebug for ReadResponse

fn fmt<W: ?Sized>(&self, f: &mut Formatter<'_, W>) -> Result<(), W::Error> where
    W: uWrite, 

Formats the value using the given formatter

impl Copy for ReadResponse

impl Eq for ReadResponse

impl StructuralEq for ReadResponse

impl StructuralPartialEq for ReadResponse