Struct ParseLines 

pub struct ParseLines<S> { /* private fields */ }

Adapter that drives a LineParser over chunk events and dispatches every emitted line to the inner LineVisitor (sync) or AsyncLineVisitor (async).

Implements StreamVisitor when S: LineVisitor and AsyncStreamVisitor when S: AsyncLineVisitor.

Implementations

impl<S> ParseLines<S>

pub fn new(options: LineParsingOptions, inner: S) -> Self

Creates a new line adapter.

Panics

Panics if options.max_line_length is zero. See LineParsingOptions::max_line_length for the rationale; pass crate::NumBytes::MAX for effectively-unbounded line parsing.

impl<F> ParseLines<InspectLines<F>>

where F: FnMut(Cow<'_, str>) -> Next + Send + 'static,

pub fn inspect(options: LineParsingOptions, f: F) -> Self

Convenience constructor: wraps f in an InspectLines and composes it with this adapter. Equivalent to ParseLines::new(options, InspectLines::new(f)).

Panics

Panics if options.max_line_length is zero.

impl<F, Fut> ParseLines<InspectLinesAsync<F, Fut>>

where F: FnMut(Cow<'_, str>) -> Fut + Send + 'static, Fut: Future<Output = Next> + Send + 'static,

pub fn inspect_async(options: LineParsingOptions, f: F) -> Self

Convenience constructor: wraps f in an InspectLinesAsync and composes it with this adapter. Equivalent to ParseLines::new(options, InspectLinesAsync::new(f)).

Panics

Panics if options.max_line_length is zero.

impl<T, F> ParseLines<CollectLines<T, F>>

where T: Sink, F: FnMut(Cow<'_, str>, &mut T) -> Next + Send + 'static,

pub fn collect(options: LineParsingOptions, sink: T, f: F) -> Self

Convenience constructor: wraps sink and f in a CollectLines and composes it with this adapter.

Panics

Panics if options.max_line_length is zero.

impl<T, F> ParseLines<CollectLinesAsync<T, F>>

where T: Sink, F: for<'a> FnMut(Cow<'a, str>, &'a mut T) -> Pin<Box<dyn Future<Output = Next> + Send + 'a>> + Send + 'static,

pub fn collect_async(options: LineParsingOptions, sink: T, f: F) -> Self

Convenience constructor: wraps sink and f in a CollectLinesAsync and composes it with this adapter. The closure must wrap its async body in Box::pin(async move { ... }).

Panics

Panics if options.max_line_length is zero.

Trait Implementations

impl<S: AsyncLineVisitor> AsyncStreamVisitor for ParseLines<S>

type Output = <S as AsyncLineVisitor>::Output

The value produced by into_output after the visitor has finished observing the stream. Returned via Consumer::wait and Consumer::cancel.

async fn on_chunk(&mut self, chunk: Chunk) -> Next

Asynchronously observes a single chunk.

fn on_gap(&mut self)

Invoked when the stream backend reports that one or more chunks were dropped between the last delivered chunk and the next one.

async fn on_eof(&mut self)

Asynchronously observes end-of-stream.

fn into_output(self) -> Self::Output

Consumes the visitor and returns its final output.

impl<S: LineVisitor> StreamVisitor for ParseLines<S>

type Output = <S as LineVisitor>::Output

The value produced by into_output after the visitor has finished observing the stream. Returned via Consumer::wait and Consumer::cancel.

fn on_chunk(&mut self, chunk: Chunk) -> Next

Invoked for every chunk observed on the stream.

fn on_gap(&mut self)

Invoked when the stream backend reports that one or more chunks were dropped between the last delivered chunk and the next one.

fn on_eof(&mut self)

Invoked exactly once when the stream ends (EOF or write side dropped).

fn into_output(self) -> Self::Output

Consumes the visitor and returns its final output.