Struct PeekableBuffer

pub struct PeekableBuffer<T>
where
    T: Clone,
{ /* private fields */ }

Implementations

impl<T> PeekableBuffer<T>

where T: Clone,

pub fn new<E>(elements: E) -> Self

where E: AsRef<[T]>,

Creates a PeekableBuffer object that owns all elements of &[T] via cloning.

pub fn is_at_end(&self) -> bool

Returns true if the stream has reached the end.

pub fn len(&self) -> usize

Returns the number of elements in the stream.

pub fn lookaround(&self, offset: i64) -> Option<&T>

Returns a reference to the element offset positions away from the element currently being pointed to by the cursor. If the computed offset is outside the bounds of the stream, None is returned.

pub fn peek(&self) -> Option<&T>

Returns a reference to the element just after the element currently being pointed to by the cursor. This is equivalent to calling lookaround(1).

pub fn current(&self) -> Option<&T>

Returns a reference to the element currently being pointed to by the cursor. This is equivalent to calling lookaround(0).

pub fn shift(&mut self, offset: i64)

Shifts the cursor by offset positions. The computed offset will be within the range [0, len()]. If the computed offset is less than 0, the cursor will point to the first element. If the computed offset is greater than len() - 1, the cursor will point to the end and is_at_end() returns true.

pub fn advance(&mut self)

A convenience method that advances the cursor by 1. If the stream is at the end, no action is taken. This is equivalent to calling shift(1).

pub fn set_pos(&mut self, pos: usize) -> usize

Sets the zero-indexed position of the cursor. If the given pos is outside of the range of the stream length, the cursor will be set to len().

pub fn pos(&self) -> usize

Returns the current zero-indexed position of the cursor. The returned value is in the range [0, len()].

pub fn consume(&mut self) -> Option<&T>

Returns a reference to the element currently being pointed to by the cursor, then advances the pointer by 1.

pub fn take_while<P>(&mut self, predicate: P) -> impl Iterator<Item = &T>

where P: Fn(&T) -> bool,

Returns an iterator containing elements that satisfy the given predicate, starting from the element currently pointed to by the stream pointer, up to either the end of the stream, or when the predicate returns fall, whichever comes first.

pub fn take(&mut self, n: usize) -> impl Iterator<Item = &T>

Returns an iterator containing all elements in the range [pos(), pos() + n). The cursor will point to either the end of the stream, or the element at pos() + n, whichever is first. If pos() + n is outside the bounds of the stream, then the rest of the stream is consumed and is_at_end() returns true.

pub fn accept<P>(&self, predicate: P) -> bool

where P: Fn(&T) -> bool,

Returns true if the current element matches the given predicate, false otherwise. The function will return false if the stream is at the end regardless of the predicate.

pub fn slice_from(&self, from_inc: usize) -> PeekableBuffer<T>

Returns a new PeekableBuffer containing all elements from the range [from_inc, len() - 1], cloning the required elements into their own iterable. If from_inc is outside the range of the stream, an empty PeekableBuffer is returned.

pub fn slice_between(&self, from_inc: usize, to_exc: usize) -> PeekableBuffer<T>

Returns a new PeekableBuffer containing all elements from the range [from_inc, to_exc - 1], cloning the required elements into their own iterable. If from_inc > to_exc, this function will panic. Otherwise, if from_inc is greater than len(), an empty PeekableBuffer is returned. If from_inc == to_exc, an empty PeekableBuffer is returned as well.

Trait Implementations

impl<T> Clone for PeekableBuffer<T>

where T: Clone + Clone,

fn clone(&self) -> PeekableBuffer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PeekableBuffer<T>

where T: Clone + Debug,

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

Formats the value using the given formatter.

impl<T> IntoIterator for PeekableBuffer<T>

where T: Clone,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> PartialEq for PeekableBuffer<T>

where T: Clone + PartialEq,

fn eq(&self, other: &PeekableBuffer<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Eq for PeekableBuffer<T>

where T: Clone + Eq,

impl<T> StructuralPartialEq for PeekableBuffer<T>

where T: Clone,