Skip to main content

PacketCodec

Struct PacketCodec 

Source
pub struct PacketCodec { /* private fields */ }
Expand description

Frames and parses ECR17 packets for a given LrcMode.

Implementations§

Source§

impl PacketCodec

Source

pub fn new(mode: LrcMode) -> Self

Creates a codec that computes LRCs under mode.

Source

pub fn lrc_mode(&self) -> LrcMode

The configured LRC mode.

Source

pub fn encode_application(&self, payload: &[u8]) -> Vec<u8>

Encodes an application frame: STX + payload + ETX + LRC.

Source

pub fn encode_control(&self, ctrl: u8) -> Vec<u8>

Encodes a control frame: ctrl + ETX + LRC, where the LRC is computed over the single-byte payload [ctrl] under the configured LrcMode (so it folds STX/ETX exactly as an application-frame LRC would).

Source

pub fn decode(&self, data: &[u8]) -> DecodedPacket

Decodes exactly one frame from data.

ACK/NAK are recognized by their lead byte only: on the wire a control frame is ctrl + ETX + LRC (what encode_control produces and what the session frames), so [ACK, ETX, LRC] decodes to PacketType::Ack. This leniency is required — the session hands decode the full 3-byte control frame, and requiring a bare 1-byte ACK would make every transaction’s ACK handshake fail. See docs/LESSON.md.

For STX/SOH frames the buffer must be exactly one frame: more than one frame, trailing bytes after the LRC, a missing LRC, or a progress frame not terminated by EOT all decode to PacketType::Unknown.

Trait Implementations§

Source§

impl Clone for PacketCodec

Source§

fn clone(&self) -> PacketCodec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PacketCodec

Source§

impl Debug for PacketCodec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.