Struct xsens_mti::prelude::Frame [−][src]
pub struct Frame<T: AsRef<[u8]>> { /* fields omitted */ }
Implementations
impl<T: AsRef<[u8]>> Frame<T>
[src]
impl<T: AsRef<[u8]>> Frame<T>
[src]pub const PREAMBLE: u8
[src]
pub const STD_LEN_IS_EXT: u8
[src]
pub const HEADER_SIZE: usize
[src]
pub const EXT_HEADER_SIZE: usize
[src]
pub const PREAMBLE_SIZE: usize
[src]
pub const EXT_LEN_SIZE: usize
[src]
pub const CHECKSUM_SIZE: usize
[src]
pub const MAX_FRAME_SIZE: usize
[src]
pub fn new_unchecked(buffer: T) -> Frame<T>
[src]
pub fn new(buffer: T) -> Result<Frame<T>, FrameError>
[src]
pub fn check_len(&self) -> Result<(), FrameError>
[src]
pub fn check_preamble(&self) -> Result<(), FrameError>
[src]
pub fn check_payload_length(&self) -> Result<(), FrameError>
[src]
pub fn check_checksum(&self) -> Result<(), FrameError>
[src]
pub fn into_inner(self) -> T
[src]
pub fn header_len() -> usize
[src]
pub fn header_len() -> usize
[src]Return the length of a message header.
Does not include extended length, payload or checksum byte.
pub fn buffer_len(n_payload_bytes: usize) -> usize
[src]
pub fn buffer_len(n_payload_bytes: usize) -> usize
[src]Return the length of a buffer required to hold a message
with a payload length of n_payload_bytes
+ CHECKSUM_SIZE
.
pub fn preamble(&self) -> u8
[src]
pub fn bus_id(&self) -> BusId
[src]
pub fn message_id(&self) -> MessageId
[src]
pub fn payload_length(&self) -> Result<PayloadLength, FrameError>
[src]
pub fn checksum(&self) -> Result<u8, FrameError>
[src]
pub fn compute_checksum(&self) -> Result<u8, FrameError>
[src]
pub fn compute_checksum(&self) -> Result<u8, FrameError>
[src]Sum of all bytes excluding the preamble
impl<'a, T: AsRef<[u8]> + ?Sized> Frame<&'a T>
[src]
impl<'a, T: AsRef<[u8]> + ?Sized> Frame<&'a T>
[src]pub fn payload(&self) -> Result<&'a [u8], FrameError>
[src]
pub fn payload(&self) -> Result<&'a [u8], FrameError>
[src]Return a pointer to the payload.
Does not include the checksum byte.
impl<T: AsRef<[u8]> + AsMut<[u8]>> Frame<T>
[src]
impl<T: AsRef<[u8]> + AsMut<[u8]>> Frame<T>
[src]pub fn set_preamble(&mut self)
[src]
pub fn set_bus_id(&mut self, value: BusId)
[src]
pub fn set_message_id(&mut self, value: MessageId)
[src]
pub fn set_payload_length(&mut self, value: PayloadLength)
[src]
pub fn payload_mut(&mut self) -> Result<&mut [u8], FrameError>
[src]
pub fn payload_mut(&mut self) -> Result<&mut [u8], FrameError>
[src]Return a mutable pointer to the payload.
Does not include the checksum byte.
pub fn set_checksum(&mut self, value: u8) -> Result<(), FrameError>
[src]
Trait Implementations
Auto Trait Implementations
impl<T> Send for Frame<T> where
T: Send,
T: Send,
impl<T> Sync for Frame<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Frame<T> where
T: Unpin,
T: Unpin,