Struct FindResult 

pub struct FindResult {

    pub symbol: String,
    pub name: String,
    pub scope: Option<String>,
    pub root: PathBuf,
    pub hits: Vec<Hit>,
    pub matched_total: usize,
    pub truncated: bool,
    pub limit: usize,
    pub files_scanned: usize,
    pub bytes_scanned: u64,
    pub definitions_indexed: usize,
    pub skipped: Skipped,
    pub ignore_files: Vec<String>,
    pub caveats: Vec<String>,
    pub elapsed: Duration,
}

The result of one find.

Fields

symbol: String

The symbol as given.

name: String

The name part after scope splitting (find for App::find).

scope: Option<String>

The scope part, if the symbol had one and it was used to filter.

root: PathBuf

Absolute path of the tree that was scanned.

hits: Vec<Hit>

Hits, best first, at most limit.

matched_total: usize

Hits before truncation.

truncated: bool

limit: usize

files_scanned: usize

Files whose text reached an extractor.

bytes_scanned: u64

definitions_indexed: usize

Definitions extracted across all scanned files, matched or not.

skipped: Skipped

ignore_files: Vec<String>

Root-relative paths of the ignore files that were honoured, in walk order.

caveats: Vec<String>

What the counts cannot say: no ignore file, a symbol defined in several files, a scope that matched nothing. Never empty out of politeness (SPEC §7, same rule).

elapsed: Duration

Trait Implementations

impl Clone for FindResult

fn clone(&self) -> FindResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindResult

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

Formats the value using the given formatter.