Trait frame_support::dispatch::Input

pub trait Input {
    pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>;
    pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>;

    pub fn read_byte(&mut self) -> Result<u8, Error> { ... }
    pub fn descend_ref(&mut self) -> Result<(), Error> { ... }
    pub fn ascend_ref(&mut self) { ... }
}

Trait that allows reading of data into a slice.

Required methods

pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>

Should return the remaining length of the input data. If no information about the input length is available, None should be returned.

The length is used to constrain the preallocation while decoding. Returning a garbage length can open the doors for a denial of service attack to your application. Otherwise, returning None can decrease the performance of your application.

pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill the given buffer.

Note that this function is similar to std::io::Read::read_exact and not std::io::Read::read.

Loading content...

Provided methods

pub fn read_byte(&mut self) -> Result<u8, Error>

Read a single byte from the input.

pub fn descend_ref(&mut self) -> Result<(), Error>

Descend into nested reference when decoding. This is called when decoding a new refence-based instance, such as Vec or Box. Currently all such types are allocated on the heap.

pub fn ascend_ref(&mut self)

Ascend to previous structure level when decoding. This is called when decoding reference-based type is finished.

Loading content...

Implementations on Foreign Types

impl<'a> Input for &'a [u8]

pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>

pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

impl<R> Input for IoReader<R> where
    R: Read + Seek, 

pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>

pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

impl<'a, T> Input for AppendZerosInput<'a, T> where
    T: Input, 

pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>

pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

impl<'a> Input for TrailingZeroInput<'a>

pub fn remaining_len(&mut self) -> Result<Option<usize>, Error>

pub fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

Loading content...

Implementors

Loading content...