Struct genio::util::WriteTrunc

pub struct WriteTrunc<W> { /* fields omitted */ }

Truncates writing so that at most n bytes in total are written into the writer.

Excess bytes are silently dropped.

Methods

impl<W: Write> WriteTrunc<W>

pub fn new(writer: W, max_bytes: u64) -> Self

Initializes truncate.

pub fn remaining_bytes(&self) -> u64

Returns how many bytes remain until they will be truncated.

Trait Implementations

impl<W: Write> Write for WriteTrunc<W>

type WriteError = W::WriteError

Value of this type is returned when write() fails.

type FlushError = W::FlushError

Value of this type is returned when flush() fails. In case of low-level writers flush often does nothing and therefore doesn't return error, so this type might be Void.

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

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

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

Attempts to write an entire buffer into this Write.

fn flush(&mut self) -> Result<(), Self::FlushError>

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

fn size_hint(&mut self, bytes: usize)

Hints the writer how much bytes will be written after call to this function. If the maximum amount of bytes to be written is known then it should be passed as argument. If the maximum amount is unknown, then minimum should be passed.

fn uses_size_hint(&self) -> bool

Reports to the caller whether size hint is actually used. This can prevent costly computation of size hint that would be thrown away.