Struct rg::search::SearchResult

pub struct SearchResult {
    has_match: bool,
    stats: Option<Stats>,
}

The result of executing a search.

Generally speaking, the “result” of a search is sent to a printer, which writes results to an underlying writer such as stdout or a file. However, every search also has some aggregate statistics or meta data that may be useful to higher level routines.

Fields

has_match: bool

stats: Option<Stats>

Implementations

impl SearchResult

pub fn has_match(&self) -> bool

Whether the search found a match or not.

pub fn stats(&self) -> Option<&Stats>

Return aggregate search statistics for a single search, if available.

It can be expensive to compute statistics, so these are only present if explicitly enabled in the printer provided by the caller.

Trait Implementations

impl Clone for SearchResult

fn clone(&self) -> SearchResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResult

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

Formats the value using the given formatter.

impl Default for SearchResult

fn default() -> SearchResult

Returns the “default value” for a type.