Struct grep_printer::SummarySink [−][src]
pub struct SummarySink<'p, 's, M: Matcher, W: 's> { /* fields omitted */ }
An implementation of Sink
associated with a matcher and an optional file
path for the summary printer.
This type is generic over a few type parameters:
'p
refers to the lifetime of the file path, if one is provided. When no file path is given, then this is'static
.'s
refers to the lifetime of theSummary
printer that this type borrows.M
refers to the type of matcher used bygrep_searcher::Searcher
that is reporting results to this sink.W
refers to the underlying writer that this printer is writing its output to.
Methods
impl<'p, 's, M: Matcher, W: WriteColor> SummarySink<'p, 's, M, W>
[src]
impl<'p, 's, M: Matcher, W: WriteColor> SummarySink<'p, 's, M, W>
pub fn has_match(&self) -> bool
[src]
pub fn has_match(&self) -> bool
Returns true if and only if this printer received a match in the previous search.
This is unaffected by the result of searches before the previous search.
pub fn binary_byte_offset(&self) -> Option<u64>
[src]
pub fn binary_byte_offset(&self) -> Option<u64>
If binary data was found in the previous search, this returns the offset at which the binary data was first detected.
The offset returned is an absolute offset relative to the entire set of bytes searched.
This is unaffected by the result of searches before the previous
search. e.g., If the search prior to the previous search found binary
data but the previous search found no binary data, then this will
return None
.
pub fn stats(&self) -> Option<&Stats>
[src]
pub fn stats(&self) -> Option<&Stats>
Return a reference to the stats produced by the printer for all searches executed on this sink.
This only returns stats if they were requested via the
SummaryBuilder
configuration.
Trait Implementations
impl<'p, 's, M: Debug + Matcher, W: Debug + 's> Debug for SummarySink<'p, 's, M, W>
[src]
impl<'p, 's, M: Debug + Matcher, W: Debug + 's> Debug for SummarySink<'p, 's, M, W>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'p, 's, M: Matcher, W: WriteColor> Sink for SummarySink<'p, 's, M, W>
[src]
impl<'p, 's, M: Matcher, W: WriteColor> Sink for SummarySink<'p, 's, M, W>
type Error = Error
The type of an error that should be reported by a searcher. Read more
fn matched(
&mut self,
_searcher: &Searcher,
mat: &SinkMatch
) -> Result<bool, Error>
[src]
fn matched(
&mut self,
_searcher: &Searcher,
mat: &SinkMatch
) -> Result<bool, Error>
This method is called whenever a match is found. Read more
fn begin(&mut self, _searcher: &Searcher) -> Result<bool, Error>
[src]
fn begin(&mut self, _searcher: &Searcher) -> Result<bool, Error>
This method is called when a search has begun, before any search is executed. By default, this does nothing. Read more
fn finish(
&mut self,
searcher: &Searcher,
finish: &SinkFinish
) -> Result<(), Error>
[src]
fn finish(
&mut self,
searcher: &Searcher,
finish: &SinkFinish
) -> Result<(), Error>
This method is called when a search has completed. By default, this does nothing. Read more
fn context(
&mut self,
_searcher: &Searcher,
_context: &SinkContext
) -> Result<bool, Self::Error>
[src]
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
. Read more
fn context_break(&mut self, _searcher: &Searcher) -> Result<bool, Self::Error>
[src]
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
. Read more
Auto Trait Implementations
impl<'p, 's, M, W> Send for SummarySink<'p, 's, M, W> where
M: Send,
W: Send,
impl<'p, 's, M, W> Send for SummarySink<'p, 's, M, W> where
M: Send,
W: Send,
impl<'p, 's, M, W> !Sync for SummarySink<'p, 's, M, W>
impl<'p, 's, M, W> !Sync for SummarySink<'p, 's, M, W>