Trait diny_core::backend::Encode

pub trait Encode: Sized {
    type Format: FormatEncode;
    type Data: ?Sized;
    fn init(data: &Self::Data) -> Self;
    fn poll_encode<W>(
        &mut self, 
        format: &Self::Format, 
        writer: &mut W, 
        data: &Self::Data, 
        cx: &mut Context<'_>
    ) -> PollEncodeStatus<<<Self as Encode>::Format as Format>::Error>
    where
        W: AsyncWrite + Unpin;

    fn start_encode<W>(
        format: &Self::Format, 
        writer: &mut W, 
        data: &Self::Data, 
        cx: &mut Context<'_>
    ) -> StartEncodeStatus<Self, <<Self as Encode>::Format as Format>::Error>
    where
        W: AsyncWrite + Unpin,
    { ... }
}

Attempt to encode a data structure to an asynchronous writer for a particular format.

Associated Types

type Format: FormatEncode

The concrete format to encode with.

type Data: ?Sized

The concrete data structure to encode.

Required methods

fn init(data: &Self::Data) -> Self

Initialize the internal state of the encoder.

fn poll_encode<W>(
    &mut self,
    format: &Self::Format,
    writer: &mut W,
    data: &Self::Data,
    cx: &mut Context<'_>
) -> PollEncodeStatus<<<Self as Encode>::Format as Format>::Error> where
    W: AsyncWrite + Unpin, 

Continue a pending Encode operation.

Provided methods

fn start_encode<W>(
    format: &Self::Format,
    writer: &mut W,
    data: &Self::Data,
    cx: &mut Context<'_>
) -> StartEncodeStatus<Self, <<Self as Encode>::Format as Format>::Error> where
    W: AsyncWrite + Unpin, 

Begin encoding bytes for the indicated format to the provided writer.

This is intended to be overriden whenever an optimized code path exists for the (usual) case where enough buffer space is available that the operation will succeed immediately without pending.

Implementation

Implementions must ensure that start_encode is semantically equivalent to calling init followed by poll_encode

Implementors

impl<T> Encode for T where
    T: BufferEncode, 

type Format = T::Format

type Data = T::Data