Struct Codec

pub struct Codec<Input, Output>(/* private fields */)
where
    Input: Decode,
    Output: Encode,
    AgentError: From<Input::Error>;

SSH framing codec.

This codec first reads an u32 which indicates the length of the incoming message. Then decodes the message using specified Input type.

The reverse transformation which appends the length of the encoded data is also implemented for the given Output type.

Trait Implementations

impl<Input, Output> Debug for Codec<Input, Output>

where Input: Decode + Debug, Output: Encode + Debug, AgentError: From<Input::Error>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Input, Output> Decoder for Codec<Input, Output>

where Input: Decode, Output: Encode, AgentError: From<Input::Error>,

type Item = Input

The type of decoded frames.

type Error = AgentError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl<Input, Output> Default for Codec<Input, Output>

where Input: Decode, Output: Encode, AgentError: From<Input::Error>,

fn default() -> Self

Returns the “default value” for a type.

impl<Input, Output> Encoder<Output> for Codec<Input, Output>

where Input: Decode, Output: Encode, AgentError: From<Input::Error>,

type Error = AgentError

The type of encoding errors.

fn encode( &mut self, item: Output, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.