Struct grep_printer::PathPrinterBuilder

pub struct PathPrinterBuilder { /* private fields */ }

A builder for a printer that emits file paths.

Implementations

impl PathPrinterBuilder

pub fn new() -> PathPrinterBuilder

Return a new path printer builder with a default configuration.

pub fn build<W: WriteColor>(&self, wtr: W) -> PathPrinter<W>

Create a new path printer with the current configuration that writes paths to the given writer.

pub fn color_specs(&mut self, specs: ColorSpecs) -> &mut PathPrinterBuilder

Set the user color specifications to use for coloring in this printer.

A UserColorSpec can be constructed from a string in accordance with the color specification format. See the UserColorSpec type documentation for more details on the format. A ColorSpecs can then be generated from zero or more UserColorSpecs.

Regardless of the color specifications provided here, whether color is actually used or not is determined by the implementation of WriteColor provided to build. For example, if termcolor::NoColor is provided to build, then no color will ever be printed regardless of the color specifications provided here.

This completely overrides any previous color specifications. This does not add to any previously provided color specifications on this builder.

The default color specifications provide no styling.

pub fn hyperlink(&mut self, config: HyperlinkConfig) -> &mut PathPrinterBuilder

Set the configuration to use for hyperlinks output by this printer.

Regardless of the hyperlink format provided here, whether hyperlinks are actually used or not is determined by the implementation of WriteColor provided to build. For example, if termcolor::NoColor is provided to build, then no hyperlinks will ever be printed regardless of the format provided here.

This completely overrides any previous hyperlink format.

The default configuration results in not emitting any hyperlinks.

pub fn separator(&mut self, sep: Option<u8>) -> &mut PathPrinterBuilder

Set the path separator used when printing file paths.

Typically, printing is done by emitting the file path as is. However, this setting provides the ability to use a different path separator from what the current environment has configured.

A typical use for this option is to permit cygwin users on Windows to set the path separator to / instead of using the system default of \.

This is disabled by default.

pub fn terminator(&mut self, terminator: u8) -> &mut PathPrinterBuilder

Set the path terminator used.

The path terminator is a byte that is printed after every file path emitted by this printer.

The default path terminator is \n.

Trait Implementations

impl Clone for PathPrinterBuilder

fn clone(&self) -> PathPrinterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathPrinterBuilder

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

Formats the value using the given formatter.