Struct Packet 

pub struct Packet<T: AsRef<[u8]>> { /* private fields */ }

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub const HEADER_SIZE: usize = 3usize

pub const CHECKSUM_SIZE: usize = 2usize

pub const OFFSET_SIZE: usize = 2usize

pub const MAX_PAYLOAD_SIZE: usize = 1_024usize

pub const MAX_MSG_ID_SIZE: usize = 15usize

pub const BASE_PACKET_SIZE: usize = 5usize

pub const MAX_PACKET_SIZE: usize = 1_044usize

pub const CRC16_CCITT_FALSE: Algorithm<u16>

pub fn new_unchecked(buffer: T) -> Packet<T>

pub fn new(buffer: T) -> Result<Packet<T>, Error>

pub fn check_len(&self) -> Result<(), Error>

pub fn check_payload_length(&self) -> Result<(), Error>

Checks that the buffer contains enough bytes to read both the message ID and the payload bytes

pub fn check_checksum(&self) -> Result<(), Error>

pub fn wire_size(&self) -> Result<usize, Error>

pub fn into_inner(self) -> T

pub fn buffer_len(n_msg_id_bytes: usize, n_payload_bytes: usize) -> usize

Return the length of a buffer required to hold a message with a payload length of n_msg_id_bytes + n_payload_bytes.

pub fn data_length(&self) -> u16

pub fn typ_raw(&self) -> u8

pub fn typ(&self) -> MessageType

pub fn internal(&self) -> bool

pub fn offset(&self) -> bool

pub fn id_length_raw(&self) -> u8

pub fn id_length(&self) -> Result<usize, Error>

pub fn response(&self) -> bool

pub fn acknum(&self) -> u8

pub fn checksum(&self) -> Result<u16, Error>

pub fn compute_checksum(&self) -> Result<u16, Error>

impl<T: AsRef<[u8]>> Packet<T>

pub fn msg_id_raw(&self) -> Result<&[u8], Error>

pub fn msg_id(&self) -> Result<MessageId<'_>, Error>

pub fn payload(&self) -> Result<&[u8], Error>

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

pub fn set_data_length(&mut self, value: u16) -> Result<(), Error>

pub fn set_typ(&mut self, value: MessageType)

pub fn set_internal(&mut self, value: bool)

pub fn set_offset(&mut self, value: bool)

pub fn set_id_length(&mut self, value: u8) -> Result<(), Error>

pub fn set_response(&mut self, value: bool)

pub fn set_acknum(&mut self, value: u8)

pub fn msg_id_mut(&mut self) -> Result<&mut [u8], Error>

pub fn payload_mut(&mut self) -> Result<&mut [u8], Error>

pub fn set_checksum(&mut self, value: u16) -> Result<(), Error>

Trait Implementations

impl<T: AsRef<[u8]>> AsRef<[u8]> for Packet<T>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> Display for Packet<T>

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

Formats the value using the given formatter.