Struct Packet

pub struct Packet {
    pub start_byte: u8,
    pub length: u8,
    pub payload: Vec<u8>,
    pub checksum: u8,
    pub end_byte: u8,
}

Represents a packet with start, length, payload, checksum, and end bytes

Fields

start_byte: u8

Start byte (START_BYTE)

length: u8

Length of payload

payload: Vec<u8>

Payload

checksum: u8

Checksum

end_byte: u8

End byte (END_BYTE)

Implementations

impl Packet

pub fn new(payload: Vec<u8>) -> Self

Creates a new packet with the given payload.

The payload will be escaped and the checksum will be calculated.

pub fn calculate_checksum(payload: &[u8]) -> u8

Calculates the checksum of the given payload.

pub fn escape_payload(payload: &[u8]) -> Vec<u8>

Escapes the given payload by replacing START_BYTE, END_BYTE, and ESCAPE_BYTE with their escaped versions.

pub fn unescape_payload(payload: &[u8]) -> Vec<u8>

Unescapes the given payload by replacing ESCAPE_BYTE with its unescaped version.

pub fn to_bytes(&self) -> Vec<u8>

Converts the packet to its byte representation.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, &'static str>

Creates a packet from its byte representation.

Trait Implementations

impl Debug for Packet

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

Formats the value using the given formatter.

impl PartialEq for Packet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Packet