Struct grep_searcher::SinkFinish [−][src]
pub struct SinkFinish { /* fields omitted */ }
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
.
Methods
impl SinkFinish
[src]
impl SinkFinish
pub fn byte_count(&self) -> u64
[src]
pub fn byte_count(&self) -> u64
Return the total number of bytes searched.
pub fn binary_byte_offset(&self) -> Option<u64>
[src]
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
[src]
impl Clone for SinkFinish
fn clone(&self) -> SinkFinish
[src]
fn clone(&self) -> SinkFinish
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0
[src]Performs copy-assignment from source
. Read more
impl Debug for SinkFinish
[src]
impl Debug for SinkFinish
Auto Trait Implementations
impl Send for SinkFinish
impl Send for SinkFinish
impl Sync for SinkFinish
impl Sync for SinkFinish