Trait Decode

pub trait Decode: Sized {
    type Error: From<Error>;

    // Required method
    fn decode(reader: &mut impl Reader) -> Result<Self, Self::Error>;
}

Decoding trait.

This trait describes how to decode a given type.

Required Associated Types

type Error: From<Error>

Type returned in the event of a decoding error.

Required Methods

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

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Decode for CertType

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<CertType, Error>

impl Decode for KeypairData

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<KeypairData, Error>

impl Decode for KeyData

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<KeyData, Error>

impl Decode for bool

Decode a boolean as described in RFC4251 § 5:

A boolean value is stored as a single byte. The value 0 represents FALSE, and the value 1 represents TRUE. All non-zero values MUST be interpreted as TRUE; however, applications MUST NOT store values other than 0 and 1.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<bool, Error>

impl Decode for u8

Decode a single byte from the input data.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<u8, Error>

impl Decode for u32

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.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<u32, Error>

impl Decode for u64

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).

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<u64, Error>

impl Decode for usize

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.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<usize, Error>

impl Decode for String

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<String, Error>

impl Decode for Vec<u8>

Decodes Vec<u8> from string as described in RFC4251 § 5:

Arbitrary length binary string. Strings are allowed to contain arbitrary binary data, including null characters and 8-bit characters. They are stored as a uint32 containing its length (number of bytes that follow) and zero (= empty string) or more bytes that are the value of the string. Terminating null characters are not used.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<Vec<u8>, Error>

impl Decode for Vec<String>

Decodes Vec<String> from name-list as described in RFC4251 § 5:

A string containing a comma-separated list of names. A name-list is represented as a uint32 containing its length (number of bytes that follow) followed by a comma-separated list of zero or more names. A name MUST have a non-zero length, and it MUST NOT contain a comma (“,”). As this is a list of names, all of the elements contained are names and MUST be in US-ASCII. Context may impose additional restrictions on the names. For example, the names in a name-list may have to be a list of valid algorithm identifiers (see Section 6 below), or a list of RFC3066 language tags. The order of the names in a name-list may or may not be significant. Again, this depends on the context in which the list is used. Terminating null characters MUST NOT be used, neither for the individual names, nor for the list as a whole.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<Vec<String>, Error>

impl Decode for OptionsMap

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<OptionsMap, Error>

impl Decode for Comment

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<Comment, Error>

impl Decode for DsaKeypair

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<DsaKeypair, Error>

impl Decode for DsaPrivateKey

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<DsaPrivateKey, Error>

impl Decode for Ed25519Keypair

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<Ed25519Keypair, Error>

impl Decode for OpaqueKeypairBytes

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<OpaqueKeypairBytes, Error>

impl Decode for OpaquePrivateKeyBytes

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<OpaquePrivateKeyBytes, Error>

impl Decode for RsaKeypair

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<RsaKeypair, Error>

impl Decode for RsaPrivateKey

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<RsaPrivateKey, Error>

impl Decode for SkEd25519

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<SkEd25519, Error>

impl Decode for DsaPublicKey

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<DsaPublicKey, Error>

impl Decode for Ed25519PublicKey

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<Ed25519PublicKey, Error>

impl Decode for OpaquePublicKeyBytes

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<OpaquePublicKeyBytes, Error>

impl Decode for RsaPublicKey

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<RsaPublicKey, Error>

impl Decode for SkEd25519

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<SkEd25519, Error>

impl Decode for SshSig

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<SshSig, Error>

impl<const N: usize> Decode for [u8; N]

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.

Note that unlike string, this type is encoded without a length prefix, but instead implicitly obtains its length as N.

type Error = Error

fn decode(reader: &mut impl Reader) -> Result<[u8; N], Error>

Implementors

impl Decode for Kdf

type Error = Error

impl Decode for Mpint

type Error = Error

impl Decode for Certificate

type Error = Error

impl Decode for PrivateKey

type Error = Error

impl Decode for Signature

type Error = Error

impl<T> Decode for T

where T: Label,

type Error = Error