Struct grep_searcher::sinks::UTF8

pub struct UTF8<F>(pub F)
where
    F: FnMut(u64, &str) -> Result<bool, Error>;

A sink that provides line numbers and matches as strings while ignoring everything else.

This implementation will return an error if a match contains invalid UTF-8 or if the searcher was not configured to count lines. Errors on invalid UTF-8 can be suppressed by using the Lossy sink instead of this one.

The closure accepts two parameters: a line number and a UTF-8 string containing the matched data. The closure returns a Result<bool, std::io::Error>. If the bool is false, then the search stops immediately. Otherwise, searching continues.

If multi line mode was enabled, the line number refers to the line number of the first line in the match.

Tuple Fields

0: F

Trait Implementations

impl<F> Clone for UTF8<F>where F: FnMut(u64, &str) -> Result<bool, Error> + Clone,

fn clone(&self) -> UTF8<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for UTF8<F>where F: FnMut(u64, &str) -> Result<bool, Error> + Debug,

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

Formats the value using the given formatter.

impl<F> Sink for UTF8<F>where F: FnMut(u64, &str) -> Result<bool, Error>,

type Error = Error

The type of an error that should be reported by a searcher.

fn matched( &mut self, _searcher: &Searcher, mat: &SinkMatch<'_> ) -> Result<bool, Error>

This method is called whenever a match is found.

fn context( &mut self, _searcher: &Searcher, _context: &SinkContext<'_> ) -> Result<bool, Self::Error>

This method is called whenever a context line is found, and is optional to implement. By default, it does nothing and returns true.

fn context_break(&mut self, _searcher: &Searcher) -> Result<bool, Self::Error>

This method is called whenever a break in contextual lines is found, and is optional to implement. By default, it does nothing and returns true.

fn binary_data( &mut self, _searcher: &Searcher, _binary_byte_offset: u64 ) -> Result<bool, Self::Error>

This method is called whenever binary detection is enabled and binary data is found. If binary data is found, then this is called at least once for the first occurrence with the absolute byte offset at which the binary data begins.

fn begin(&mut self, _searcher: &Searcher) -> Result<bool, Self::Error>

This method is called when a search has begun, before any search is executed. By default, this does nothing.

fn finish( &mut self, _searcher: &Searcher, _: &SinkFinish ) -> Result<(), Self::Error>

This method is called when a search has completed. By default, this does nothing.