Struct Enumerate

pub struct Enumerate<R> { /* private fields */ }

A type that keeps track of how many sites have been read from the underlying source.

Constructed using ReadSite::enumerate.

Implementations

impl<R> Enumerate<R>

where R: ReadSite,

pub fn sites_read(&self) -> usize

Returns the number of sites read from the underlying source.

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

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

See also ReadSite::take.

Trait Implementations

impl<R> ReadSite for Enumerate<R>

where R: ReadSite,

type Site = <R as ReadSite>::Site

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<R> Rewind for Enumerate<R>

where R: Rewind,

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.