rusftp 0.2.1

SFTP library based on russh
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

// This file is part of the rusftp project
//
// Copyright (C) ANEO, 2024-2024. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use serde::{Deserialize, Serialize};

use crate::message::{Attrs, Path};

/// Request to open a file for reading or writing.
///
/// It is answered with [`Handle`](crate::message::Handle) in case of success
/// and [`Status`](crate::message::Status) in case of failure.
///
/// internal: `SSH_FXP_OPEN`
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Open {
    /// Path of the file to open
    pub filename: Path,
    /// Flags for the file opening
    pub pflags: PFlags,
    /// Default file attributes to use upon file creation
    pub attrs: Attrs,
}

bitflags::bitflags! {
    #[repr(transparent)]
    #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
    pub struct PFlags: u32 {
        /// Open the file for reading.
        ///
        /// internal: `SSH_FXF_READ`
        const READ = 0x00000001;

        /// Open the file for writing.
        /// If both this and `READ` are specified, the file is opened for both reading and writing.
        ///
        /// internal: `SSH_FXF_WRITE`
        const WRITE = 0x00000002;

        /// Force all writes to append data at the end of the file.
        ///
        /// internal: `SSH_FXF_APPEND`
        const APPEND = 0x00000004;

        /// If this flag is specified, then a new file will be created if one does not already exist
        /// (if O_TRUNC is specified, the new file will be truncated to zero length if it previously exists).
        ///
        /// internal: `SSH_FXF_CREAT`
        const CREATE = 0x00000008;

        /// Forces an existing file with the same name to be truncated to zero length when creating a file by specifying `CREATE`.
        /// `CREATE` MUST also be specified if this flag is used.
        ///
        /// internal: `SSH_FXF_TRUNC`
        const TRUNCATE = 0x00000010;

        /// Causes the request to fail if the named file already exists.
        /// `CREATE` MUST also be specified if this flag is used.
        ///
        /// internal: `SSH_FXF_EXCL`
        const EXCLUDE = 0x00000020;
    }
}

#[cfg(test)]
mod test {
    use crate::message::{
        test_utils::{encode_decode, fail_decode},
        Attrs, Path,
    };
    use crate::wire::Error;

    use super::{Open, PFlags};

    const OPEN_VALID: &[u8] = b"\0\0\0\x08filename\0\0\0\x09\0\0\0\x01\0\0\0\0\0\x0a\x77\x35";

    #[test]
    fn encode_success() {
        encode_decode(
            Open {
                filename: Path("filename".to_owned()),
                pflags: PFlags::READ | PFlags::CREATE,
                attrs: Attrs {
                    size: Some(0xa7735),
                    ..Default::default()
                },
            },
            OPEN_VALID,
        );
    }

    #[test]
    fn decode_failure() {
        for i in 0..OPEN_VALID.len() {
            assert_eq!(fail_decode::<Open>(&OPEN_VALID[..i]), Error::NotEnoughData);
        }
    }
}