Struct rubbl_core::io::AligningReader

pub struct AligningReader<R: Read> { /* fields omitted */ }

This struct wraps a Read type to equip it with hooks to track its alignment — that is, how many bytes into the stream the read 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<R: Read> AligningReader<R>

pub fn new(inner: R) -> Self

Create a new AligningReader that wraps the argument inner.

pub fn into_inner(self) -> R

Consume this struct, returning the underlying inner reader.

pub fn offset(&self) -> u64

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

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

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

Read and discard 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 read is performed.

Trait Implementations

impl<R: Debug + Read> Debug for AligningReader<R>

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

Formats the value using the given formatter.

impl<R: Read> Read for AligningReader<R>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.