Struct StreamCleaner 

pub struct StreamCleaner { /* private fields */ }

Incremental cleaner that processes text in newline-delimited chunks.

Implementations

impl StreamCleaner

pub fn new(options: CleaningOptions) -> Self

Construct a streaming cleaner from options.

Arguments

• options: Cleaning behavior configuration.

Returns

A new StreamCleaner.

pub fn from_cleaner(cleaner: TextCleaner) -> Self

Construct a streaming cleaner from an existing TextCleaner.

Arguments

• cleaner: Preconfigured text cleaner.

Returns

A new StreamCleaner.

pub fn feed<'out>( &mut self, chunk: &str, out: &'out mut String, ) -> Option<CleaningResult<'out>>

Feed one input chunk and emit cleaned output only after a newline boundary is available.

Arguments

• chunk: Incoming text data.
• out: Reusable output buffer.

Returns

Some(CleaningResult) when at least one complete line was processed, otherwise None.

Panics

Panics when normalization is requested but the unorm feature is disabled.

pub fn finish<'out>( &mut self, out: &'out mut String, ) -> Option<CleaningResult<'out>>

Flush remaining buffered text at end-of-stream.

Arguments

• out: Reusable output buffer.

Returns

Final cleaned chunk when buffered content remains, otherwise None.

pub fn summary(&self) -> StreamSummary

Return cumulative stream statistics.

Returns

Aggregate counters and total change count.