Struct Limit 

pub struct Limit<'a, R: Reader + ?Sized> { /* private fields */ }

Wraps a reader and limits the amount of data that can be read from it

This can be used for applying back pressure to the reader with flow control.

Implementations

impl<'a, R: Reader + ?Sized> Limit<'a, R>

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

Trait Implementations

impl<R: Reader + ?Sized> Reader for Limit<'_, R>

fn current_offset(&self) -> VarInt

Returns the currently read offset for the stream

fn final_offset(&self) -> Option<VarInt>

Returns the final offset for the stream

fn has_buffered_fin(&self) -> bool

Returns true if the reader has the final offset buffered

fn is_consumed(&self) -> bool

Returns true if the reader is finished producing data

fn skip_until(&mut self, offset: VarInt) -> Result<(), Self::Error>

Skips the data in the reader until offset is reached, or the reader storage is exhausted.

fn with_max_data(&mut self, max_data: VarInt) -> Limit<'_, Self>

Limits the maximum offset that the caller can read from the reader

fn with_read_limit(&mut self, max_buffered_len: usize) -> Limit<'_, Self>

Limits the maximum amount of data that the caller can read from the reader

fn with_empty_buffer(&self) -> Empty<'_, Self>

Return an empty view onto the reader, with no change in current offset

fn with_checks(&mut self) -> Checked<'_, Self>

Enables checking the reader for correctness invariants

impl<R: Reader + ?Sized> Storage for Limit<'_, R>

type Error = <R as Storage>::Error

fn buffered_len(&self) -> usize

Returns the length of the chunk

fn read_chunk(&mut self, watermark: usize) -> Result<Chunk<'_>, Self::Error>

Reads the current contiguous chunk

fn partial_copy_into<Dest>( &mut self, dest: &mut Dest, ) -> Result<Chunk<'_>, Self::Error>

where Dest: Storage + ?Sized,

Copies the reader into dest, with a trailing chunk of bytes.

fn copy_into<Dest>(&mut self, dest: &mut Dest) -> Result<(), Self::Error>

where Dest: Storage + ?Sized,

Copies the reader into dest.

fn buffer_is_empty(&self) -> bool

Returns if the chunk is empty

fn full_copy(&mut self) -> FullCopy<'_, Self>

Forces the entire reader to be copied, even when calling partial_copy_into.

fn track_read(&mut self) -> Tracked<'_, Self>

Tracks the number of bytes read from the storage