Struct grep_printer::Summary [−][src]
pub struct Summary<W> { /* fields omitted */ }The summary printer, which emits aggregate results from a search.
Aggregate results generally correspond to file paths and/or the number of matches found.
A default printer can be created with either of the Summary::new or
Summary::new_no_color constructors. However, there are a number of
options that configure this printer's output. Those options can be
configured using SummaryBuilder.
This type is generic over W, which represents any implementation of
the termcolor::WriteColor trait.
Methods
impl<W: WriteColor> Summary<W>[src]
impl<W: WriteColor> Summary<W>pub fn new(wtr: W) -> Summary<W>[src]
pub fn new(wtr: W) -> Summary<W>Return a summary printer with a default configuration that writes matches to the given writer.
The writer should be an implementation of termcolor::WriteColor
and not just a bare implementation of io::Write. To use a normal
io::Write implementation (simultaneously sacrificing colors), use
the new_no_color constructor.
The default configuration uses the Count summary mode.
impl<W: Write> Summary<NoColor<W>>[src]
impl<W: Write> Summary<NoColor<W>>pub fn new_no_color(wtr: W) -> Summary<NoColor<W>>[src]
pub fn new_no_color(wtr: W) -> Summary<NoColor<W>>Return a summary printer with a default configuration that writes matches to the given writer.
The writer can be any implementation of io::Write. With this
constructor, the printer will never emit colors.
The default configuration uses the Count summary mode.
impl<W: WriteColor> Summary<W>[src]
impl<W: WriteColor> Summary<W>pub fn sink<'s, M: Matcher>(
&'s mut self,
matcher: M
) -> SummarySink<'static, 's, M, W>[src]
pub fn sink<'s, M: Matcher>(
&'s mut self,
matcher: M
) -> SummarySink<'static, 's, M, W>Return an implementation of Sink for the summary printer.
This does not associate the printer with a file path, which means this
implementation will never print a file path. If the output mode of
this summary printer does not make sense without a file path (such as
PathWithMatch or PathWithoutMatch), then any searches executed
using this sink will immediately quit with an error.
pub fn sink_with_path<'p, 's, M, P: ?Sized>(
&'s mut self,
matcher: M,
path: &'p P
) -> SummarySink<'p, 's, M, W> where
M: Matcher,
P: AsRef<Path>, [src]
pub fn sink_with_path<'p, 's, M, P: ?Sized>(
&'s mut self,
matcher: M,
path: &'p P
) -> SummarySink<'p, 's, M, W> where
M: Matcher,
P: AsRef<Path>, Return an implementation of Sink associated with a file path.
When the printer is associated with a path, then it may, depending on its configuration, print the path.
impl<W> Summary<W>[src]
impl<W> Summary<W>pub fn has_written(&self) -> bool[src]
pub fn has_written(&self) -> boolReturns true if and only if this printer has written at least one byte to the underlying writer during any of the previous searches.
pub fn get_mut(&mut self) -> &mut W[src]
pub fn get_mut(&mut self) -> &mut WReturn a mutable reference to the underlying writer.
pub fn into_inner(self) -> W[src]
pub fn into_inner(self) -> WConsume this printer and return back ownership of the underlying writer.