Struct Reader

pub struct Reader<const D: usize, R> { /* private fields */ }

A pseudo-shuffled SAF file reader.

Implementations

impl<const D: usize, R> Reader<D, R>

where R: BufRead,

A pseudo-shuffled SAF file reader.

pub fn get(&self) -> &R

Returns the inner reader.

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

Returns a mutable reference to the the inner reader.

pub fn header(&self) -> &Header

Returns the header of the reader.

pub fn into_inner(self) -> R

Returns the inner reader, consuming self.

pub fn new(reader: R, header: Header) -> Self

Creates a new reader.

The stream is expected to be positioned after the header.

pub fn read_header(&mut self) -> Result<Header>

Reads the header from the reader.

The stream is assumed to be positioned at the beginning.

impl<const D: usize> Reader<D, BufReader<File>>

pub fn try_from_path<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Creates a new reader from a path, and read its header.

Returns an error if the dimensionality defined in the header is not D.

The stream will be positioned after the header.

Trait Implementations

impl<const D: usize, R> ReadSite for Reader<D, R>

where R: BufRead + Seek,

type Site = Site<D>

The type of site that can be read.

fn read_site(&mut self, buf: &mut Self::Site) -> Result<ReadStatus>

Reads a single site into the provided buffer.

fn read_site_unnormalised(&mut self, buf: &mut Self::Site) -> Result<ReadStatus>

Reads a single site into the provided buffer without normalising out of log-space.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Returns a reader adaptor which counts the number of sites read.

fn take(self, max_sites: usize) -> Take<Enumerate<Self>>

where Self: Sized,

Returns a reader adaptor which limits the number of sites read.

impl<const D: usize, R> Rewind for Reader<D, R>

where R: BufRead + Seek,

fn is_done(&mut self) -> Result<bool>

Returns true if reader has reached the end of the data, false otherwise.

fn rewind(&mut self) -> Result<()>

Positions reader at the beginning of the data.

impl<const D: usize, R> Seek for Reader<D, R>

where R: BufRead + Seek,

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.