Struct SizeRestrictedBuffer 

pub struct SizeRestrictedBuffer { /* private fields */ }

This type wraps a Vec to provide a Write interface that has a max capacity that won’t be exceeded. Additionally, it gracefully handles out-of-memory conditions instead of panicking (unfortunately not compatible with the no-panic crate, though).

Implementations

impl SizeRestrictedBuffer

pub const fn zero_capacity() -> Self

Returns a buffer which can never hold any data.

pub fn try_new(size_hint: usize, max_capacity: usize) -> Result<Self>

Tries to create an initial buffer with the provided size hint as well as the provided max capacity. Neither number is required to be a power of 2.

Errors

• Fails if the size_hint is larger than the max_capacity.
• Fails if memory cannot be reserved.

pub fn as_slice(&self) -> &[u8]

Trait Implementations

impl AsRef<[u8]> for SizeRestrictedBuffer

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl From<SizeRestrictedBuffer> for Vec<u8>

fn from(buf: SizeRestrictedBuffer) -> Self

Converts to this type from the input type.

impl Write for SizeRestrictedBuffer

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

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

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

Flushes 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, args: 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.