Skip to main content

Event

Enum Event 

Source
#[non_exhaustive]
pub enum Event { Started { check: Check, }, Progress { bytes: u64, total: Option<u64>, }, FileEnd { data: Vec<u8>, last_block: usize, padding: usize, }, Error(Error), Done, }
Expand description

Something that happened during a transfer.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Started

The check the transfer runs with is settled: sender, on the receiver’s start character, and again if a later start character before the first ACK changes it (C or D at any time before the first ACK; NAK only after D, the 49G’s fallback to checksum: after C a NAK asks for a damaged block 1 again in CRC-16); receiver, on the first block.

Fields

§check: Check

The block check in use.

§

Progress

After each acknowledged block (send) or accepted new block (receive).

Fields

§bytes: u64

Bytes of the file acknowledged (send, at most the file size) or received (receive, padding included).

§total: Option<u64>

File size when sending; None when receiving.

§

FileEnd

Receive: EOT acknowledged; the file as received.

Fields

§data: Vec<u8>

Every data byte received, padding of the last block included: stripping it is the caller’s job. XModem carries no file length. For an HP object (the calculators send binary objects: an 8-byte HPHP48-x/HPHP49-x header, then the object), the real end is found by walking the object: read its prolog and the size its type implies (a length field for strings, code and the like, the nested objects for composites), and cut there.

§last_block: usize

Size of the last block (128 or 1024; 0 for an empty transfer): the most padding the file can carry.

§padding: usize

Trailing bytes of the last block equal to its final byte, when that byte is 0x1A or 0x00: the likely padding. A hint only; real data may end in such bytes, and the 49G’s XSEND pads with whatever follows the object in memory (hint 0), while the 48GX pads with zeros. Only the object-length walk finds the real end.

§

Error(Error)

Terminal failure; the machine is idle.

§

Done

Terminal success. The machine is idle, or, as receiver, lingers after the final ACK (Config::linger).

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Self

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 Debug for Event

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Event

Source§

impl PartialEq for Event

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Forget for Event

§

impl Freeze for Event

§

impl Move for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.