bssh-russh-sftp 2.3.0

Temporary fork of russh-sftp 2.3.0 adding pipelined SFTP File I/O (write_all_pipelined / read_to_writer_pipelined). These helpers hide per-request RTT for fast bulk transfers and are the only value-add over upstream russh-sftp.
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

use crate::protocol::StatusCode;

/// Response sent by [`Handler`](super::Handler) for any request that completes
/// via the `Err` arm. Mapped to an `SSH_FXP_STATUS` packet.
///
/// `error_message` and `language_tag` fall back to `status_code.to_string()`
/// and `"en-US"` respectively when left as `None`, so simple cases that only
/// carry a [`StatusCode`] stay allocation-free.
#[derive(Debug, Clone, PartialEq)]
pub struct StatusReply {
    pub status_code: StatusCode,
    pub error_message: Option<String>,
    pub language_tag: Option<String>,
}

impl StatusReply {
    pub fn new(status_code: StatusCode) -> Self {
        Self {
            status_code,
            error_message: None,
            language_tag: None,
        }
    }

    pub fn with_message(mut self, message: impl Into<String>) -> Self {
        self.error_message = Some(message.into());
        self
    }

    pub fn with_language_tag(mut self, tag: impl Into<String>) -> Self {
        self.language_tag = Some(tag.into());
        self
    }
}

impl From<StatusCode> for StatusReply {
    fn from(status_code: StatusCode) -> Self {
        Self::new(status_code)
    }
}

// Lives here, not in `protocol/status.rs`, to keep `protocol` free of a
// dependency on `server`-side types.
impl StatusCode {
    /// Attach a custom message to this status code and produce a [`StatusReply`].
    ///
    /// Shorthand for `StatusReply::new(code).with_message(msg)`.
    pub fn with_message(self, message: impl Into<String>) -> StatusReply {
        StatusReply::new(self).with_message(message)
    }
}