Struct ReadSpec 

pub struct ReadSpec<'a> {

    pub views: Option<&'a str>,
    pub format: Option<&'a str>,
    pub words_per_page: Option<&'a str>,
    pub include: &'a [String],
    pub exclude: &'a [String],
    pub min_size: Option<&'a str>,
    pub modified_since: Option<&'a str>,
    pub modified_before: Option<&'a str>,
    pub kinds: Option<&'a str>,
    pub ignored: Option<&'a str>,
    pub depth: Option<&'a str>,
    pub min_share: Option<&'a str>,
    pub breadth: Option<&'a str>,
    pub limit: Option<&'a str>,
    pub sort: Option<&'a str>,
    pub reverse: bool,
    pub size: Option<&'a str>,
}

What one read supplies, as its caller wrote it: the Query half of a request.

Split from the basis half rather than flattened beside it, because a holder of stored state fixes root, scope, and analyzers once and then answers many reads: a read names only this, and Request::read is what takes the two together. A field declared in both halves is a field one of them could silently drop, which is why this is the one declaration and RequestSpec contains it.

Fields

views: Option<&'a str>

Views: a comma list, or full.

format: Option<&'a str>

Presentation format; omitted means automatic human output.

words_per_page: Option<&'a str>

Logical words per document page: a positive integer.

include: &'a [String]

Patterns an entry must match one of.

exclude: &'a [String]

Patterns that exclude an entry.

min_size: Option<&'a str>

Smallest size, as 512, 10M, or 1.5GiB.

modified_since: Option<&'a str>

Inclusive lower bound on modification time, as 2h or a timestamp.

modified_before: Option<&'a str>

Exclusive upper bound on modification time.

kinds: Option<&'a str>

Entry kinds: a comma list of file, dir, symlink, or other.

ignored: Option<&'a str>

Selection by ignored state: include, exclude, or only.

depth: Option<&'a str>

Rendered tree depth: a whole number or all.

min_share: Option<&'a str>

Minimum displayed contribution to the selected root, as a percentage.

breadth: Option<&'a str>

Maximum immediate children shown per directory: a whole number or all.

limit: Option<&'a str>

Rows per view: a whole number or all.

sort: Option<&'a str>

Ordering key: size, count, mtime, or name.

reverse: bool

Reverse the ordering.

size: Option<&'a str>

Size metric: allocated or apparent.

Implementations

impl ReadSpec<'_>

pub const fn new() -> Self

A read that names nothing, so every axis takes its default.

Trait Implementations

impl<'a> Clone for ReadSpec<'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 ReadSpec<'a>

impl<'a> Debug for ReadSpec<'a>

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

Formats the value using the given formatter.

impl Default for ReadSpec<'_>

fn default() -> Self

Returns the “default value” for a type.