zmodem2 0.7.3

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2026 Jarkko Sakkinen

//! Public protocol primitives for the poll/submit API.

/// Byte offset in a ZMODEM file transfer.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Position(u32);

impl Position {
    /// Start of a file.
    pub const ZERO: Self = Self(0);

    /// Creates a file position from a byte offset.
    #[must_use]
    pub const fn new(offset: u32) -> Self {
        Self(offset)
    }

    /// Returns the byte offset.
    #[must_use]
    pub const fn get(self) -> u32 {
        self.0
    }
}

impl From<u32> for Position {
    fn from(offset: u32) -> Self {
        Self::new(offset)
    }
}

impl From<Position> for u32 {
    fn from(position: Position) -> Self {
        position.get()
    }
}

/// File metadata advertised by the sender.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct FileInfo<'a> {
    /// Raw file name bytes as sent on the wire.
    pub name: &'a [u8],
    /// File size when known.
    pub size: Option<Position>,
    /// When the file was last changed, in seconds since the Unix epoch
    /// (UTC), when known. `rz` gives a file without it the time it is
    /// received.
    pub modified: Option<u32>,
    /// The file's Unix mode when known, e.g. `0o100_644` for a regular
    /// file readable by all and writable by its owner. `rz` takes the
    /// 0x8000 bit for "a regular file of a Unix-like system", whose
    /// contents it passes through unchanged.
    pub mode: Option<u32>,
}

impl<'a> FileInfo<'a> {
    /// Creates file metadata from raw name bytes and an optional size.
    #[must_use]
    pub const fn new(name: &'a [u8], size: Option<Position>) -> Self {
        Self {
            name,
            size,
            modified: None,
            mode: None,
        }
    }

    /// The same metadata with a modification time (seconds since the Unix
    /// epoch, UTC).
    #[must_use]
    pub const fn with_modified(mut self, modified: u32) -> Self {
        self.modified = Some(modified);
        self
    }

    /// The same metadata with a Unix mode.
    #[must_use]
    pub const fn with_mode(mut self, mode: u32) -> Self {
        self.mode = Some(mode);
        self
    }
}

/// The next action the caller must perform, returned by
/// [`Sender::poll`](crate::Sender::poll) and
/// [`Receiver::poll`](crate::Receiver::poll).
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Action<'a> {
    /// Write these bytes to the transport, then report progress with
    /// `wire_written`.
    WriteWire(&'a [u8]),
    /// Read at most `max_len` file bytes at `offset` and provide them with
    /// [`Sender::submit_file`](crate::Sender::submit_file). Senders only.
    ReadFile { offset: Position, max_len: usize },
    /// Persist these received bytes, then report progress with
    /// [`Receiver::file_written`](crate::Receiver::file_written). Receivers
    /// only.
    WriteFile(&'a [u8]),
    /// A protocol event occurred.
    Event(Event<'a>),
    /// No work is pending. Submit more wire input with `submit_wire`, or wait
    /// for a `timeout`.
    Idle,
}

/// Protocol-level event surfaced through [`Action::Event`].
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Event<'a> {
    /// A new incoming file started, with its advertised metadata.
    FileStarted(FileInfo<'a>),
    /// The current file completed.
    FileCompleted,
    /// The session completed successfully.
    SessionCompleted,
    /// The session was aborted.
    Aborted,
}