Struct grep_searcher::SinkFinish

pub struct SinkFinish { /* private fields */ }

Summary data reported at the end of a search.

This reports data such as the total number of bytes searched and the absolute offset of the first occurrence of binary data, if any were found.

A searcher that stops early because of an error does not call finish. A searcher that stops early because the Sink implementor instructed it to will still call finish.

Implementations

impl SinkFinish

pub fn byte_count(&self) -> u64

Return the total number of bytes searched.

pub fn binary_byte_offset(&self) -> Option<u64>

If binary detection is enabled and if binary data was found, then this returns the absolute byte offset of the first detected byte of binary data.

Note that since this is an absolute byte offset, it cannot be relied upon to index into any addressable memory.

Trait Implementations

impl Clone for SinkFinish

fn clone(&self) -> SinkFinish

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinkFinish

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

Formats the value using the given formatter.