Trait diny_core::backend::Decode

pub trait Decode: Sized {
    type Format: FormatDecode;
    type Data;
    fn init() -> Self;
    fn poll_decode<R>(
        &mut self, 
        format: &Self::Format, 
        reader: &mut R, 
        cx: &mut Context<'_>
    ) -> PollDecodeStatus<Self::Data, <<Self as Decode>::Format as Format>::Error>
    where
        R: AsyncBufRead + Unpin;

    fn start_decode<R>(
        format: &Self::Format, 
        reader: &mut R, 
        cx: &mut Context<'_>
    ) -> StartDecodeStatus<Self::Data, Self, <<Self as Decode>::Format as Format>::Error>
    where
        R: AsyncBufRead + Unpin,
    { ... }
}

Attempt to decode a data structure from an asynchronous reader for a particular format

Associated Types

type Format: FormatDecode

The concrete format to decode with.

type Data

The concrete data structure to decode.

Required methods

fn init() -> Self

Initialize the internal state of the decoder.

fn poll_decode<R>(
    &mut self,
    format: &Self::Format,
    reader: &mut R,
    cx: &mut Context<'_>
) -> PollDecodeStatus<Self::Data, <<Self as Decode>::Format as Format>::Error> where
    R: AsyncBufRead + Unpin, 

Continue a pending Decode operation.

Provided methods

fn start_decode<R>(
    format: &Self::Format,
    reader: &mut R,
    cx: &mut Context<'_>
) -> StartDecodeStatus<Self::Data, Self, <<Self as Decode>::Format as Format>::Error> where
    R: AsyncBufRead + Unpin, 

Begin decoding bytes for the indicated format from the provided reader.

This is intended to be overriden whenever an optimized code path exists for the (usual) case where enough bytes have been buffered into the reader that the operation will succeed immediately without pending.

Implementation

Implementions must ensure that start_decode is semantically equivalent to calling init followed by poll_decode

Implementors