ssh-packet 0.11.0

A library implementing SSH packet reading/writing using `binrw`.
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

//! Structures definitions & traits to manipulate them.

use binrw::{
    BinRead, BinWrite,
    meta::{ReadEndian, WriteEndian},
};

/// A trait representing a _packet_ in the SSH protocol.
pub trait Packet:
    for<'r> BinRead<Args<'r> = ()> + ReadEndian + for<'w> BinWrite<Args<'w> = ()> + WriteEndian
{
    /// Convert from _binary wire format_.
    fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self, Error> {
        Self::read(&mut std::io::Cursor::new(bytes.as_ref())).map_err(Error)
    }

    /// Convert to _binary wire format_.
    fn to_bytes(&self) -> Vec<u8> {
        let mut buf = std::io::Cursor::new(Vec::new());
        self.write(&mut buf).unwrap_or_else(|err| {
            panic!(
                "failed to serialize `{}`: {err}",
                std::any::type_name::<Self>()
            )
        });

        buf.into_inner()
    }
}

/// An error that can occur while converting from and to _binary wire format_.
#[derive(Debug)]
pub struct Error(binrw::Error);

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl std::error::Error for Error {}