Struct Read

pub struct Read { /* private fields */ }

I/O-free coroutine for reading bytes into a buffer.

Implementations

impl Read

pub const DEFAULT_CAPACITY: usize = 8_192usize

The default read buffer capacity.

pub fn new() -> Self

Creates a new coroutine to read bytes using a buffer with Self::DEFAULT_CAPACITY capacity.

See Self::with_capacity for a custom buffer capacity.

pub fn with_capacity(capacity: usize) -> Self

Creates a new coroutine to read bytes using a buffer with the given capacity.

pub fn capacity(&self) -> usize

Returns the buffer capacity.

This function does not return directly the capacity of the buffer, it returns instead the initial capacity the coroutine was created with.

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the buffer to the given capacity.

pub fn replace(&mut self, buffer: Vec<u8>)

Replaces the inner buffer with the given one.

pub fn resume(&mut self, arg: Option<Io>) -> Result<Output, Io>

Makes the read progress.

Trait Implementations

impl Debug for Read

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Read

fn default() -> Self

Returns the “default value” for a type.