Struct grep_printer::Standard

source ·
pub struct Standard<W> { /* private fields */ }
Expand description

The standard printer, which implements grep-like formatting, including color support.

A default printer can be created with either of the Standard::new or Standard::new_no_color constructors. However, there are a considerable number of options that configure this printer’s output. Those options can be configured using StandardBuilder.

This type is generic over W, which represents any implementation of the termcolor::WriteColor trait. If colors are not desired, then the new_no_color constructor can be used, or, alternatively, the termcolor::NoColor adapter can be used to wrap any io::Write implementation without enabling any colors.

Implementations§

source§

impl<W: WriteColor> Standard<W>

source

pub fn new(wtr: W) -> Standard<W>

Return a standard 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.

source§

impl<W: Write> Standard<NoColor<W>>

source

pub fn new_no_color(wtr: W) -> Standard<NoColor<W>>

Return a standard 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.

source§

impl<W: WriteColor> Standard<W>

source

pub fn sink<'s, M: Matcher>( &'s mut self, matcher: M ) -> StandardSink<'static, 's, M, W>

Return an implementation of Sink for the standard printer.

This does not associate the printer with a file path, which means this implementation will never print a file path along with the matches.

source

pub fn sink_with_path<'p, 's, M, P>( &'s mut self, matcher: M, path: &'p P ) -> StandardSink<'p, 's, M, W>where M: Matcher, P: ?Sized + 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 along with the matches found.

source§

impl<W> Standard<W>

source

pub fn has_written(&self) -> bool

Returns true if and only if this printer has written at least one byte to the underlying writer during any of the previous searches.

source

pub fn get_mut(&mut self) -> &mut W

Return a mutable reference to the underlying writer.

source

pub fn into_inner(self) -> W

Consume this printer and return back ownership of the underlying writer.

Trait Implementations§

source§

impl<W: Debug> Debug for Standard<W>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<W> !RefUnwindSafe for Standard<W>

§

impl<W> Send for Standard<W>where W: Send,

§

impl<W> !Sync for Standard<W>

§

impl<W> Unpin for Standard<W>where W: Unpin,

§

impl<W> UnwindSafe for Standard<W>where W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.