Struct XmodemPacket

#[repr(C)]
pub struct XmodemPacket { /* private fields */ }

Represents an XMODEM packet.

Implementations

impl XmodemPacket

pub const LEN: usize = 132usize

Represents the full byte length of an original XMODEM packet.

pub const fn new() -> Self

Creates a new XmodemPacket.

pub const fn start(&self) -> Control

Gets the start Control byte.

pub const fn sequence(&self) -> Sequence

Gets the Sequence number.

pub fn set_sequence(&mut self, seq: Sequence)

Sets the Sequence, and complement Sequence numbers.

pub const fn with_sequence(self, seq: Sequence) -> Self

Builder function that sets the Sequence, and complement Sequence numbers.

pub const fn complement_sequence(&self) -> Sequence

Gets the complement Sequence number.

pub const fn data(&self) -> &XmodemData

Gets a reference to the XmodemData.

pub fn set_data(&mut self, data: XmodemData)

Sets the XmodemData, and calculates the Checksum.

pub const fn with_data(self, data: XmodemData) -> Self

Builder function that sets the XmodemData, and calculates the Checksum.

pub const fn checksum(&self) -> Checksum

Gets the Checksum.

pub const fn validate(self) -> Result<Self>

Validates the invariants of the XmodemPacket format.

Consumes and returns the XmodemPacket, if valid.

Returns Error otherwise.

pub fn into_bytes(self) -> [u8; 132]

Infallible conversion from XmodemPacket into bytes.

NOTE: does not validate XmodemPacket before conversion. For the validating version, use XmodemPacket::try_into.

Trait Implementations

impl Clone for XmodemPacket

fn clone(&self) -> XmodemPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmodemPacket

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

Formats the value using the given formatter.

impl Default for XmodemPacket

fn default() -> Self

Returns the “default value” for a type.

impl IntoIterator for XmodemPacket

type Item = u8

The type of the elements being iterated over.

type IntoIter = Chain<Chain<IntoIter<u8, { XmodemPacket::PRELUDE_LEN }>, IntoIter<u8, { XmodemData::LEN }>>, IntoIter<u8, { Checksum::LEN }>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for XmodemPacket

fn eq(&self, other: &XmodemPacket) -> 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 TryFrom<&[u8]> for XmodemPacket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &[u8]) -> Result<Self>

Performs the conversion.

impl<const N: usize> TryFrom<&[u8; N]> for XmodemPacket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &[u8; N]) -> Result<Self>

Performs the conversion.

impl TryFrom<&XmodemPacket> for [u8; 132]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &XmodemPacket) -> Result<Self>

Performs the conversion.

impl<const N: usize> TryFrom<[u8; N]> for XmodemPacket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: [u8; N]) -> Result<Self>

Performs the conversion.

impl TryFrom<XmodemPacket> for [u8; 132]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: XmodemPacket) -> Result<Self>

Performs the conversion.

impl Copy for XmodemPacket

impl Eq for XmodemPacket

impl StructuralPartialEq for XmodemPacket