Struct rubbl_core::io::AligningWriter

pub struct AligningWriter<W: Write> { /* fields omitted */ }

In analogoy with AligningReader, this struct wraps a Write type to equip it with hooks to track its alignment — that is, how many bytes into the stream the write has progressed, and whether the current offset is an exact multiple of a certain number of bytes from the beginning.

Streams often have alignment requirements so that they can safely be mapped into in-memory data structures. In particular, this is the case for MIRIAD files.

Implementations

impl<W: Write> AligningWriter<W>

pub fn new(inner: W) -> Self

Create a new AligningWriter that wraps the argument inner.

pub fn into_inner(self) -> W

Consume this struct, returning the underlying inner writer.

pub fn offset(&self) -> u64

Return how many bytes we have written since this struct was created.

Note that this offset is tracked internally. If you open a file, write some data, and then create an AligningWriter, the returned offset will refer to the number of bytes written since creation, not the actual file position as understood by the underlying OS.

pub fn align_to(&mut self, alignment: usize) -> Result<bool>

Write zero bytes to ensure that the stream is aligned as specified.

The maximum allowed alignment value is 64 bytes.

Returns whether the stream was already at the right alignment. When that is the case, no write is performed.

Trait Implementations

impl<W: Debug + Write> Debug for AligningWriter<W>

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

Formats the value using the given formatter.

impl<W: Write> Write for AligningWriter<W>

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 Writeer 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

Creates a "by reference" adaptor for this instance of Write.