Struct rg::subject::SubjectBuilder

pub struct SubjectBuilder {
    config: Config,
}

A builder for constructing things to search over.

Fields

config: Config

Implementations

impl SubjectBuilder

pub fn new() -> SubjectBuilder

Return a new subject builder with a default configuration.

pub fn build_from_result( &self, result: Result<DirEntry, Error> ) -> Option<Subject>

Create a new subject from a possibly missing directory entry.

If the directory entry isn’t present, then the corresponding error is logged if messages have been configured. Otherwise, if the subject is deemed searchable, then it is returned.

pub fn build(&self, dent: DirEntry) -> Option<Subject>

Create a new subject using this builder’s configuration.

If a subject could not be created or should otherwise not be searched, then this returns None after emitting any relevant log messages.

pub fn strip_dot_prefix(&mut self, yes: bool) -> &mut SubjectBuilder

When enabled, if the subject’s file path starts with ./ then it is stripped.

This is useful when implicitly searching the current working directory.

Trait Implementations

impl Clone for SubjectBuilder

fn clone(&self) -> SubjectBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubjectBuilder

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

Formats the value using the given formatter.