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

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

//! Session-level events and internal phase names.

use crate::wire::SubpacketType;

/// A request for file data from the sender.
#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) struct FileRequest {
    pub offset: u32,
    pub len: usize,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum SenderEvent {
    FileComplete,
    SessionComplete,
    Aborted,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum ReceiverEvent {
    FileStart,
    FileComplete,
    SessionComplete,
    Aborted,
}

/// Internal state for reading a subpacket byte-by-byte
#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum SubpacketPhase {
    Idle,
    /// Consuming the CR LF XON line trailer that separates a hex
    /// header from its data subpacket.
    SkipTrailer,
    Reading,
    Writing(SubpacketType),
    Crc(SubpacketType),
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum SenderPhase {
    WaitReceiverInit,
    ReadyForFile,
    WaitFilePos,
    NeedFileData,
    WaitFileAck,
    WaitFileDone,
    WaitFinish,
    Done,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum ReceiverPhase {
    SessionBegin,
    SinitReadingData,
    FileBegin,
    FileReadingMetadata,
    FileAcceptPending,
    FileReadingSubpacket,
    FileWaitingSubpacket,
    SessionEnd,
}