Struct amplify::ConfinedIo

pub struct ConfinedIo<Io, const LIM: usize> { /* private fields */ }

Errors with io::ErrorKind::UnexpectedEof on io::Read and io::Write operations if the LIM is reached.

Implementations

impl<Io, const LIM: usize> ConfinedIo<Io, LIM>

pub fn new() -> Self

where Io: Default,

Constructs new instance.

pub fn pos(&self) -> usize

Returns current position (number of bytes read or written).

pub fn as_io(&self) -> &Io

Returns reference to the inner I/O type.

pub fn into_io(self) -> Io

Converts into the inner I/O type.

pub fn to_io(&self) -> Io

where Io: Clone,

Returns clone of the inner I/O type.

pub fn is_eof(&self) -> bool

Checks if the position has reached the limit LIM.

Trait Implementations

impl<Io: Clone, const LIM: usize> Clone for ConfinedIo<Io, LIM>

fn clone(&self) -> ConfinedIo<Io, LIM>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Io: Debug, const LIM: usize> Debug for ConfinedIo<Io, LIM>

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

Formats the value using the given formatter.

impl<Io: Default, const LIM: usize> Default for ConfinedIo<Io, LIM>

fn default() -> Self

Returns the “default value” for a type.

impl<Io, const LIM: usize> From<Io> for ConfinedIo<Io, LIM>

fn from(io: Io) -> Self

Converts to this type from the input type.

impl<Io: Read, const LIM: usize> Read for ConfinedIo<Io, LIM>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Read the exact number of bytes required to fill buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<Io: Write, const LIM: usize> Write for ConfinedIo<Io, LIM>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.