Trait Decoder 

pub trait Decoder: Sized {
    type Output;
    type Error;

    // Required methods
    fn push_bytes(&mut self, bytes: &mut &[u8]) -> Result<bool, Self::Error>;
    fn end(self) -> Result<Self::Output, Self::Error>;
    fn read_limit(&self) -> usize;
}

A push decoder for a consensus-decodable object.

Required Associated Types

type Output

The type that this decoder produces when decoding is complete.

type Error

The error type that this decoder can produce.

Required Methods

fn push_bytes(&mut self, bytes: &mut &[u8]) -> Result<bool, Self::Error>

Push bytes into the decoder, consuming as much as possible.

The slice reference will be advanced to point to the unconsumed portion. Returns Ok(true) if more bytes are needed to complete decoding, Ok(false) if the decoder is ready to finalize with Self::end, or Err(error) if parsing failed.

Errors

Returns an error if the provided bytes are invalid or malformed according to the decoder’s validation rules. Insufficient data (needing more bytes) is not an error for this method, the decoder will simply consume what it can and return true to indicate more data is needed.

Panics

May panic if called after a previous call to Self::push_bytes errored.

fn end(self) -> Result<Self::Output, Self::Error>

Complete the decoding process and return the final result.

This consumes the decoder and should be called when no more input data is available.

Errors

Returns an error if the decoder has not received sufficient data to complete decoding, or if the accumulated data is invalid when considered as a complete object.

Panics

May panic if called after a previous call to Self::push_bytes errored.

fn read_limit(&self) -> usize

Returns the maximum number of bytes this decoder can consume without over-reading.

Returns 0 if the decoder is complete and ready to finalize with Self::end. This is used by decode_from_read_unbuffered to optimize read sizes, avoiding both inefficient under-reads and unnecessary over-reads.

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.

Implementors

impl Decoder for ByteVecDecoder

Available on crate feature alloc only.

type Output = Vec<u8>

type Error = ByteVecDecoderError

impl Decoder for CompactSizeDecoder

type Output = u64

type Error = CompactSizeDecoderError

impl<A, B> Decoder for Decoder2<A, B>

where A: Decoder, B: Decoder,

type Output = (<A as Decoder>::Output, <B as Decoder>::Output)

type Error = Decoder2Error<<A as Decoder>::Error, <B as Decoder>::Error>

impl<A, B, C> Decoder for Decoder3<A, B, C>

where A: Decoder, B: Decoder, C: Decoder,

type Output = (<A as Decoder>::Output, <B as Decoder>::Output, <C as Decoder>::Output)

type Error = Decoder3Error<<A as Decoder>::Error, <B as Decoder>::Error, <C as Decoder>::Error>

impl<A, B, C, D> Decoder for Decoder4<A, B, C, D>

where A: Decoder, B: Decoder, C: Decoder, D: Decoder,

type Output = (<A as Decoder>::Output, <B as Decoder>::Output, <C as Decoder>::Output, <D as Decoder>::Output)

type Error = Decoder4Error<<A as Decoder>::Error, <B as Decoder>::Error, <C as Decoder>::Error, <D as Decoder>::Error>

impl<A, B, C, D, E, F> Decoder for Decoder6<A, B, C, D, E, F>

where A: Decoder, B: Decoder, C: Decoder, D: Decoder, E: Decoder, F: Decoder,

type Output = (<A as Decoder>::Output, <B as Decoder>::Output, <C as Decoder>::Output, <D as Decoder>::Output, <E as Decoder>::Output, <F as Decoder>::Output)

type Error = Decoder6Error<<A as Decoder>::Error, <B as Decoder>::Error, <C as Decoder>::Error, <D as Decoder>::Error, <E as Decoder>::Error, <F as Decoder>::Error>

impl<T: Decodable> Decoder for VecDecoder<T>

Available on crate feature alloc only.

type Output = Vec<T>

type Error = VecDecoderError<<<T as Decodable>::Decoder as Decoder>::Error>

impl<const N: usize> Decoder for ArrayDecoder<N>

type Output = [u8; N]

type Error = UnexpectedEofError