Trait ssh_encoding::Decode

source · [−]
pub trait Decode: Sized {
    type Error: From<Error>;

    fn decode(reader: &mut impl Reader) -> Result<Self, Self::Error>;
}
Expand description

Decoding trait.

This trait describes how to decode a given type.

Required Associated Types

Type returned in the event of a decoding error.

Required Methods

Attempt to decode a value of this type using the provided Reader.

Implementations on Foreign Types

Decode a single byte from the input data.

Decode a uint32 as described in RFC4251 § 5:

Represents a 32-bit unsigned integer. Stored as four bytes in the order of decreasing significance (network byte order). For example: the value 699921578 (0x29b7f4aa) is stored as 29 b7 f4 aa.

Decode a uint64 as described in RFC4251 § 5:

Represents a 64-bit unsigned integer. Stored as eight bytes in the order of decreasing significance (network byte order).

Decode a usize.

Uses Decode impl on u32 and then converts to a usize, handling potential overflow if usize is smaller than u32.

Enforces a library-internal limit of 1048575, as the main use case for usize is length prefixes.

Decodes a byte array from byte[n] as described in RFC4251 § 5:

A byte represents an arbitrary 8-bit value (octet). Fixed length data is sometimes represented as an array of bytes, written byte[n], where n is the number of bytes in the array.

Decodes Vec<u8> from byte[n] as described in RFC4251 § 5:

A byte represents an arbitrary 8-bit value (octet). Fixed length data is sometimes represented as an array of bytes, written byte[n], where n is the number of bytes in the array.

Implementors