Struct shadow_rs::utility::give::Give

pub struct Give<T> { /* private fields */ }

Writer adapter which limits the bytes written to an underlying writer.

Intended to be a std::io::Write counterpart to std::io::Take for std::io::Read. This does not force the write limit, for example give.get_mut() can be used to write directly to the underlying writer without updating the internal state of the Give object.

Implementations

impl<T> Give<T>

pub fn new(writer: T, limit: u64) -> Self

pub fn limit(&self) -> u64

Returns the number of bytes that can be written before this instance will return a write of 0 bytes.

pub fn set_limit(&mut self, limit: u64)

Sets the number of bytes that can be read before this instance will return a write of 0 bytes. This is the same as constructing a new Give instance, so the amount of bytes read and the previous limit value don’t matter when calling this method.

pub fn into_inner(self) -> T

Consumes the Give, returning the wrapped writer.

pub fn get_ref(&self) -> &T

Gets a reference to the underlying writer.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying writer.

Trait Implementations

impl<T: Write> Write for Give<T>

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, 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.