Struct grep_printer::JSONBuilder

pub struct JSONBuilder { /* fields omitted */ }

A builder for a JSON lines printer.

The builder permits configuring how the printer behaves. The JSON printer has fewer configuration options than the standard printer because it is a structured format, and the printer always attempts to find the most information possible.

Some configuration options, such as whether line numbers are included or whether contextual lines are shown, are drawn directly from the grep_searcher::Searcher's configuration.

Once a JSON printer is built, its configuration cannot be changed.

Methods

impl JSONBuilder

pub fn new() -> JSONBuilder

Return a new builder for configuring the JSON printer.

pub fn build<W: Write>(&self, wtr: W) -> JSON<W>

Create a JSON printer that writes results to the given writer.

pub fn pretty(&mut self, yes: bool) -> &mut JSONBuilder

Print JSON in a pretty printed format.

Enabling this will no longer produce a "JSON lines" format, in that each JSON object printed may span multiple lines.

This is disabled by default.

pub fn max_matches(&mut self, limit: Option<u64>) -> &mut JSONBuilder

Set the maximum amount of matches that are printed.

If multi line search is enabled and a match spans multiple lines, then that match is counted exactly once for the purposes of enforcing this limit, regardless of how many lines it spans.

pub fn always_begin_end(&mut self, yes: bool) -> &mut JSONBuilder

When enabled, the begin and end messages are always emitted, even when no match is found.

When disabled, the begin and end messages are only shown if there is at least one match or context message.

This is disabled by default.

Trait Implementations

impl Clone for JSONBuilder

fn clone(&self) -> JSONBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JSONBuilder

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

Formats the value using the given formatter.