zmodem2 0.6.0

ZMODEM file transfer protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2017-2020 Alexey Arbuzov
// Copyright (c) 2023-2026 Jarkko Sakkinen

//! ZMODEM file transfer protocol library. `zmodem2::Sender` and
//! `zmodem2::Receiver` provide stream alike state machines for sending and
//! receiving files with the ZMODEM protocol.
//!
//! The usage can be described in the high-level with the following flow:
//! 1. Create `zmodem2::Sender` or `zmodem2::Receiver`.
//! 2. Drain `drain_outgoing()` returned bytes into the wire and call
//!    `advance_outgoing()` after writing. Then, feed incoming bytes with
//!    `feed_incoming()`.
//! 3. In the sender, complete `poll_file()` with `feed_file()` if required
//!    and handle events via `poll_event()`.
//! 4. In the receiver, write `drain_file()` returned bytes into storage, and
//!    call `advance_file()` after writing. Handle events via `poll_event()`.

#![deny(clippy::all)]
#![deny(clippy::pedantic)]
#![allow(clippy::result_large_err)]
#![cfg_attr(not(feature = "std"), no_std)]

mod api;
mod buffer;
mod crc;
#[cfg(feature = "embedded-io")]
mod embedded_io;
mod error;
mod file;
mod header;
mod io;
mod receiver;
mod sender;
mod session;
#[cfg(feature = "std")]
mod std;
mod string;
mod transmission;
mod wire;
mod zdle;

pub use api::*;
pub use buffer::*;
#[cfg(feature = "embedded-io")]
pub use embedded_io::*;
pub use error::*;
pub use header::*;
pub use io::*;
pub use string::*;
pub use transmission::*;

pub const ZPAD: u8 = b'*';
pub const ZDLE: u8 = 0x18;
pub const XON: u8 = 0x11;