Struct grep_searcher::LineStep

pub struct LineStep { /* fields omitted */ }

An explicit iterator over lines in a particular slice of bytes.

This iterator avoids borrowing the bytes themselves, and instead requires callers to explicitly provide the bytes when moving through the iterator. While not idiomatic, this provides a simple way of iterating over lines that doesn't require borrowing the slice itself, which can be convenient.

Line terminators are considered part of the line they terminate. All lines yielded by the iterator are guaranteed to be non-empty.

Methods

impl LineStep

pub fn new(line_term: u8, start: usize, end: usize) -> LineStep

Create a new line iterator over the given range of bytes using the given line terminator.

Callers should provide the actual bytes for each call to next. The same slice must be provided to each call.

This panics if start is not less than or equal to end.

pub fn next(&mut self, bytes: &[u8]) -> Option<(usize, usize)>

Return the start and end position of the next line in the given bytes.

The caller must past exactly the same slice of bytes for each call to next.

The range returned includes the line terminator. Ranges are always non-empty.

Trait Implementations

impl Debug for LineStep

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

Formats the value using the given formatter.