Trait InputBlockIterator

pub trait InputBlockIterator<'i, const N: usize> {
    type Block: InputBlock<'i, N>;
    type Error: Into<InputError>;

    // Required methods
    fn next(&mut self) -> Result<Option<Self::Block>, Self::Error>;
    fn get_offset(&self) -> usize;
    fn offset(&mut self, count: isize);
}

An iterator over blocks of input of size N. Implementations MUST guarantee that the blocks returned from next are exactly of size N.

Required Associated Types

type Block: InputBlock<'i, N>

The type of blocks returned.

type Error: Into<InputError>

Type of errors that can occur when reading from this iterator.

Required Methods

fn next(&mut self) -> Result<Option<Self::Block>, Self::Error>

Advances the iterator and returns the next value.

Errors

May fail depending on the implementation.

fn get_offset(&self) -> usize

Get the offset of the iterator in the input.

The offset is the starting point of the block that will be returned next from this iterator, if any. It starts as 0 and increases by N on every block retrieved.

fn offset(&mut self, count: isize)

Offset the iterator by count full blocks forward.

The count parameter must be greater than 0.

Implementors

impl<'a, 'r, R, const N: usize> InputBlockIterator<'a, N> for BorrowedBytesBlockIterator<'r, EndPaddedInput<'a>, R, N>

where R: InputRecorder<&'a [u8]> + 'r,

type Block = &'a [u8]

type Error = Infallible

impl<'a, 'r, R, const N: usize> InputBlockIterator<'a, N> for BorrowedBytesBlockIterator<'r, TwoSidesPaddedInput<'a>, R, N>

where R: InputRecorder<&'a [u8]> + 'r,

type Block = &'a [u8]

type Error = Infallible

impl<'a, R: Read, IR, const N: usize> InputBlockIterator<'a, N> for BufferedInputBlockIterator<'a, '_, R, IR, N>

where IR: InputRecorder<BufferedInputBlock<N>>,

type Block = BufferedInputBlock<N>

type Error = InputError