qcp 0.8.3

Secure remote file copy utility which uses the QUIC protocol over UDP
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

//! Command structures for GET and PUT
// (c) 2025 Ross Younger

use crate::protocol::session::prelude::*;

#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Default, Clone)]
/// Arguments for the `GET` command
pub struct GetArgs {
    /// This is a file name, with leading directory components as required
    pub filename: String,
}

#[derive(Serialize, Deserialize, PartialEq, Debug, Default, Clone)]
/// Arguments for the `GET2` command.
/// This was introduced in qcp 0.5 with `VersionCompatibility=V2`.
pub struct Get2Args {
    /// This is a file name, with leading directory components as required
    pub filename: String,

    /// Extended options for the GET command
    ///
    /// Supported options: [`CommandParam::PreserveMetadata`]
    pub options: Vec<TaggedData<CommandParam>>,
}
impl From<GetArgs> for Get2Args {
    fn from(v1: GetArgs) -> Self {
        Self {
            filename: v1.filename,
            options: vec![],
        }
    }
}

#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Default, Clone)]
/// Arguments for the `PUT` command
pub struct PutArgs {
    /// This is the destination file or directory name, with leading directory components as required.
    /// If it is a directory name, the filename given in the protocol `FileHeader` is appended.
    pub filename: String,
}
#[derive(Serialize, Deserialize, PartialEq, Debug, Default, Clone)]
/// Arguments for the `PUT2` command.
/// This was introduced in qcp 0.5 with `VersionCompatibility=V2`.
pub struct Put2Args {
    /// This is the destination file or directory name, with leading directory components as required.
    /// If it is a directory name, the filename given in the protocol `FileHeader` is appended.
    pub filename: String,

    /// Extended options for the PUT command
    ///
    /// Supported options: [`CommandParam::PreserveMetadata`]
    pub options: Vec<TaggedData<CommandParam>>,
}
impl From<PutArgs> for Put2Args {
    fn from(v1: PutArgs) -> Self {
        Self {
            filename: v1.filename,
            options: vec![],
        }
    }
}

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod test {
    use crate::protocol::session::Command;
    use crate::protocol::session::prelude::*;
    use pretty_assertions::assert_eq;

    #[test]
    fn wire_marshalling_command_get() {
        let cmd = Command::Get(super::GetArgs {
            filename: "myfile".to_string(),
        });
        let wire = cmd.to_vec().unwrap();
        let expected = b"\x00\x06myfile".to_vec();
        assert_eq!(wire, expected);
    }

    #[test]
    fn wire_marshalling_command_put() {
        let cmd = Command::Put(super::PutArgs {
            filename: "myfile2".to_string(),
        });
        let wire = cmd.to_vec().unwrap();
        let expected = b"\x01\x07myfile2".to_vec();
        assert_eq!(wire, expected);
    }
}