Struct constriction::backends::FallibleIteratorReadWords

pub struct FallibleIteratorReadWords<Iter: Iterator> { /* fields omitted */ }

Adapter that turns an iterator over Result<Word, ReadError> into a data source.

Wraps an iterator over Result<Word, ReadError> and implements ReadWords<Word, S, ReadError=ReadError> by pulling the iterator each time a client reads from it. If the iterator implements ExactSizeIterator then this wrapper also implements BoundedReadWords.

Implements ReadWord for arbitrary Semantics. This is legal since it doesn’t implement WriteWords, so the question how reads relate to writes is moot.

See also InfallibleIteratorReadWords, and module-level documentation for a detailed usage example.

Implementations

impl<Iter: Iterator> FallibleIteratorReadWords<Iter>

pub fn new<I, Word, ReadError>(iter: I) -> Self where
    I: IntoIterator<IntoIter = Iter>,
    Iter: Iterator<Item = Result<Word, ReadError>>, 

Creates the adapter for the provided iterator.

The provided iterator iter does not need to be fused (i.e., it may return Some after the first None even though a ReadWords wouldn’t be allowed to do the equivalent of that). The adapter calls iter.fuse() to ensure correct behavior.

You can get the (fused) iterator back by calling IntoIterator::into_iter.

Trait Implementations

impl<Iter, S, Word> BoundedReadWords<Word, S> for FallibleIteratorReadWords<Iter> where
    Self: ReadWords<Word, S>,
    Iter: ExactSizeIterator,
    S: Semantics, 

fn remaining(&self) -> usize

Returns the number of Words that are left for reading.

fn is_exhausted(&self) -> bool

Whether or not there is no data left to read.

impl<Iter: Clone + Iterator> Clone for FallibleIteratorReadWords<Iter>

fn clone(&self) -> FallibleIteratorReadWords<Iter>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Iter: Debug + Iterator> Debug for FallibleIteratorReadWords<Iter>

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

Formats the value using the given formatter.

impl<Iter: Iterator> IntoIterator for FallibleIteratorReadWords<Iter>

type Item = Iter::Item

The type of the elements being iterated over.

type IntoIter = Fuse<Iter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Iter, S, Word, ReadError> ReadWords<Word, S> for FallibleIteratorReadWords<Iter> where
    Iter: Iterator<Item = Result<Word, ReadError>>,
    S: Semantics,
    ReadError: Debug, 

Since FallibleIteratorReadWords doesn’t implement WriteWords, it is allowed to implement ReadWords for all ReadWriteLogics

type ReadError = ReadError

The error type that can occur when reading from the data source, or Infallible.

fn read(&mut self) -> Result<Option<Word>, Self::ReadError>

Reads a single Word from the data source and advances the state of the data source accordingly (i.e., so that the next read won’t read the same Word again).

fn maybe_exhausted(&self) -> bool

Returns true if the data source could be out of data.