Struct windowed_infinity::WindowedInfinity

pub struct WindowedInfinity<'a> { /* private fields */ }

A WindowedInfinity represents an infinite writable space. A small section of it is mapped to a &mut u8 to which writes are forwarded; writes to the area outside only advance a cursor.

Implementations

impl<'a> WindowedInfinity<'a>

pub fn new(view: &'a mut [u8], cursor: isize) -> Self

Create a new infinity with the window passed as view. The cursor parameter indicates where (in the index space of the view) the infinity’s write operations should start, and is typically either 0 or negative.

pub fn cursor(&self) -> isize

Report the current write cursor position in the index space of the view.

This typically used at the end of an infinity’s life time to see whether the view needs to be truncated before further processing, and whether there was any data discarded after the view.

pub fn get_cursor(&self) -> isize

👎Deprecated: Renamed to .cursor()

pub fn write(&mut self, data: &[u8])

At the current cursor position, insert the given data.

The operation is always successful, and at least changes the write cursor.

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

Obtain the written content inside the window, if any.

The slices could be made to have a longer lifetime if there is demand for that by using the sealingslice crate.

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

👎Deprecated: Renamed to .written()

pub fn tee_digest<D: Digest>(self) -> TeeForDigest<'a, D>

Create a Tee (a T-shaped writer) that writes both to this WindowedInfinity and some digest::Digest.

The resulting type implements all the same writers as the WindowedInfinity, and offers an into_windowed_and_digest(self) -> (WindowedInfinity, Digest) to get both back after writing as completed.

pub fn tee_crc64<'c>(self, crc: &'c Crc<u64>) -> TeeForCrc<'a, 'c, u64>

Create a Tee (a T-shaped writer) that writes both to this WindowedInfinity and some crc::Digest.

This is limited to u64 CRCs due to https://github.com/mrhooray/crc-rs/issues/79, and indirectly the availability of const traits.

pub fn tee_crc32<'c>(self, crc: &'c Crc<u32>) -> TeeForCrc<'a, 'c, u32>

Create a Tee (a T-shaped writer) that writes both to this WindowedInfinity and some crc::Digest.

This is limited to u32 CRCs due to https://github.com/mrhooray/crc-rs/issues/79, and indirectly the availability of const traits.

Trait Implementations

impl<'a> Io for WindowedInfinity<'a>

type Error = Infallible

Error type of all the IO operations on this type.

impl Write for WindowedInfinity<'_>

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 Selfwhere
    Self: Sized,

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

impl<'a> Write for WindowedInfinity<'a>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

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

Glue for usage of the write! macro with implementors of this trait.

impl<'a> Write for WindowedInfinity<'a>

type Error = Error

The type of error returned when a write operation fails.

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

Attempts to write an entire buffer into this write.

impl<'a> Write for WindowedInfinity<'a>

type Error = Infallible

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

Write the whole byte slice.

impl<'a> Write for WindowedInfinity<'a>

type Error = Infallible

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

Write the whole byte slice.

impl<'a> Write for WindowedInfinity<'a>

type Error = Infallible

The error type

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

Writes all bytes from data or fails

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

Flushes all output

impl<'a> Write for WindowedInfinity<'a>

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

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

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

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

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

Write an entire buffer into this writer.

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

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