rusftp 0.2.0-beta-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

// 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, Handle};

/// Request to change the attributes (metadata) of an open file or directory.
///
/// This request is used for operations such as changing the ownership,
/// permissions or access times, as well as for truncating a file.
///
/// An error will be returned if the specified file system object does not exist
/// or the user does not have sufficient rights to modify the specified attributes.
///
/// It is answered with [`Status`](crate::message::Status).
///
/// internal: `SSH_FXP_FSETSTAT`
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct FSetStat {
    /// Handle of the file or directory to change the attributes
    pub handle: Handle,
    /// New attributes to apply
    pub attrs: Attrs,
}

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

    use super::FSetStat;
    use bytes::Bytes;

    const FSETSTAT_VALID: &[u8] = b"\0\0\0\x06handle\0\0\0\x01\0\0\0\0\0\x0a\x77\x35";

    #[test]
    fn encode_success() {
        encode_decode(
            FSetStat {
                handle: Handle(Bytes::from_static(b"handle")),
                attrs: Attrs {
                    size: Some(0xa7735),
                    ..Default::default()
                },
            },
            FSETSTAT_VALID,
        );
    }

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