Struct rg::subject::Subject

pub struct Subject {
    dent: DirEntry,
    strip_dot_prefix: bool,
}

A subject is a thing we want to search. Generally, a subject is either a file or stdin.

Fields

dent: DirEntry

strip_dot_prefix: bool

Implementations

impl Subject

pub fn path(&self) -> &Path

Return the file path corresponding to this subject.

If this subject corresponds to stdin, then a special <stdin> path is returned instead.

pub fn is_stdin(&self) -> bool

Returns true if and only if this entry corresponds to stdin.

pub fn is_explicit(&self) -> bool

Returns true if and only if this entry corresponds to a subject to search that was explicitly supplied by an end user.

Generally, this corresponds to either stdin or an explicit file path argument. e.g., in rg foo some-file ./some-dir/, some-file is an explicit subject, but, e.g., ./some-dir/some-other-file is not.

However, note that ripgrep does not see through shell globbing. e.g., in rg foo ./some-dir/*, ./some-dir/some-other-file will be treated as an explicit subject.

fn is_dir(&self) -> bool

Returns true if and only if this subject points to a directory after following symbolic links.

fn is_file(&self) -> bool

Returns true if and only if this subject points to a file.

Trait Implementations

impl Clone for Subject

fn clone(&self) -> Subject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subject

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

Formats the value using the given formatter.