Struct LimitedReader 

pub struct LimitedReader<'a, R: Reads> { /* private fields */ }

A Reads wrapper that enforces byte and depth limits during decoding, protecting against malicious or malformed input.

The blanket ReadsDecodable implementation automatically wraps each top-level decode in a limited reader with default limits. Construct a LimitedReader explicitly to override the defaults:

use codas::codec::LimitedReader;
use codas::codec::ReadsDecodable;

// Custom limits:
let mut slice = encoded;
let data: u32 = LimitedReader::new(&mut slice)
    .max_bytes(1024)
    .max_depth(8)
    .read_data()?;

// No effective limits (trusted data):
let mut slice = encoded;
let data: u32 = LimitedReader::unlimited(&mut slice)
    .read_data()?;

Limits are cumulative within the LimitedReader’s lifetime: every sub-field’s bytes and nesting depth count against the same instance.

Implementations

impl<'a, R: Reads> LimitedReader<'a, R>

pub fn new(reader: &'a mut R) -> Self

Creates a new LimitedReader with default limits (DEFAULT_MAX_BYTES and DEFAULT_MAX_DEPTH).

pub fn unlimited(reader: &'a mut R) -> Self

Creates a new LimitedReader with no effective limits.

pub fn max_bytes(self, max: u64) -> Self

Sets the maximum number of bytes this reader will read.

pub fn max_depth(self, max: u32) -> Self

Sets the maximum nesting depth this reader will allow.

pub fn bytes_read(&self) -> u64

Returns the total number of bytes read so far.

Trait Implementations

impl<R: Reads> ReadsDecodable for LimitedReader<'_, R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, CodecError>

Reads bytes into buf, returning the number of bytes read.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), CodecError>

Reads exactly buf.len() bytes into buf.

fn enter_scope(&mut self) -> Result<(), CodecError>

Called when entering a nested data scope during decoding.

fn exit_scope(&mut self)

Called when exiting a nested data scope during decoding.

fn read_data<T: Decodable + Default>(&mut self) -> Result<T, CodecError>

Reads and decodes a sequence of data into a new, default instance of T.

fn read_data_into<T: Decodable>( &mut self, data: &mut T, ) -> Result<(), CodecError>

Reads and decodes a sequence of data into data.

fn skip_blob(&mut self, length: usize) -> Result<(), CodecError>

Skips to the end of the next length bytes of data.

fn skip_data(&mut self) -> Result<usize, CodecError>

Skips to the end of the next encoded sequence of data, returning the total number of bytes skipped.

fn skip_data_with_format( &mut self, format: DataFormat, ) -> Result<usize, CodecError>

Skips to the end of the next encoded instance of data with format, returning the total number of bytes skipped.