Struct RequestSpec 

pub struct RequestSpec<'a> {
    pub root: &'a Path,
    pub scan_depth: Option<&'a str>,
    pub one_filesystem: bool,
    pub read_controls: Option<bool>,
    pub control_budget: Option<&'a str>,
    pub control_line_limit: Option<&'a str>,
    pub analyze: Option<&'a str>,
    pub read: ReadSpec<'a>,
}

A request as a caller wrote it: raw values, before any grammar has read them.

Surface-neutral, so the command line and the Python API fill one shape and Request::build parses both identically. A value a surface already holds typed, such as --scan-depth, reaches this through its Display, so a disagreement between that type and the grammar here shows up as a golden difference rather than a silent one. None and an empty list mean the caller named nothing, and Request::DEFAULTS decides; the switches whose only default is off are plain booleans.

Fields

root: &'a Path

The directory the answer is about.

scan_depth: Option<&'a str>

Retention depth: a whole number.

one_filesystem: bool

Stay on the root’s filesystem.

read_controls: Option<bool>

Observe .gitignore.

control_budget: Option<&'a str>

The .gitignore budget: a size or all.

control_line_limit: Option<&'a str>

The longest .gitignore line: a size or all.

analyze: Option<&'a str>

Analyzers: a comma list of none, lines, code, words, or all.

read: ReadSpec<'a>

What this read asks of the basis the axes above describe.

Implementations

impl<'a> RequestSpec<'a>

pub const fn new(root: &'a Path) -> Self

A spec that names only its root, so every other axis takes its default.

Trait Implementations

impl<'a> Clone for RequestSpec<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RequestSpec<'a>

impl<'a> Debug for RequestSpec<'a>

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

Formats the value using the given formatter.