Skip to main content

AxisNames

Struct AxisNames 

Source
pub struct AxisNames {
Show 26 fields pub view: &'static str, pub format: &'static str, pub analyze: &'static str, pub control_budget: &'static str, pub control_line_limit: &'static str, pub exclude_ignored: &'static str, pub only_ignored: &'static str, pub read_controls: &'static str, pub scan_depth: &'static str, pub one_filesystem: &'static str, pub follow_symlinks: &'static str, pub include: &'static str, pub modified_since: &'static str, pub modified_before: &'static str, pub kind: &'static str, pub ignored: &'static str, pub depth: &'static str, pub min_share: &'static str, pub breadth: &'static str, pub limit: &'static str, pub sort: &'static str, pub size: &'static str, pub words_per_page: &'static str, pub cache: &'static str, pub stale_ok: &'static str, pub watch: &'static str,
}
Expand description

What the calling surface calls the knobs a report’s diagnostics name.

The same reason ViewSpec::resolve and AnalysisSet::parse_labeled take a label: a rule belongs to the library, but the words a caller can act on belong to the surface they came through. Telling a Python caller to “add –analyze” names a flag that does not exist in their surface – the defect that made these messages worth moving here in the first place, reappearing one door over (fdu-4apt).

The view and analyzer axes both, because both diagnostics name both: the view that cannot be answered, and the analyzer that would answer it. The two control limits, because the note about refused .gitignore files names the limit that applies them. The ignored-state selections and the observation switch, because selecting by ignored state in a scan that reads no .gitignore is refused by naming both.

And every other axis a RequestError names: the value grammars of the request model reject a value by naming its axis, and the watch refusals name the knobs a watch cannot honor, so one type states each rule and each surface supplies only its words.

Fields§

§view: &'static str

The view axis.

§format: &'static str

The output format axis.

§analyze: &'static str

The analyzer axis.

§control_budget: &'static str

The budget on retained .gitignore state.

§control_line_limit: &'static str

The limit on one .gitignore line.

§exclude_ignored: &'static str

The selection of unignored entries only.

§only_ignored: &'static str

The selection of ignored entries only.

§read_controls: &'static str

The switch that turns .gitignore observation off.

§scan_depth: &'static str

The retention depth of a scan.

§one_filesystem: &'static str

The switch that keeps a scan on the root’s filesystem.

§follow_symlinks: &'static str

The switch that walks into what a symbolic link points at.

§include: &'static str

The patterns an entry must match.

§modified_since: &'static str

The inclusive lower bound on modification time.

§modified_before: &'static str

The exclusive upper bound on modification time.

§kind: &'static str

The entry kinds a selection admits.

§ignored: &'static str

The selection by ignored state, as one axis.

§depth: &'static str

How deep a rendered tree descends.

§min_share: &'static str

The minimum displayed share of the selected root.

§breadth: &'static str

Maximum child rows per directory.

§limit: &'static str

How many rows a view keeps.

§sort: &'static str

The ordering key.

§size: &'static str

The size metric.

§words_per_page: &'static str

The logical-word denominator of a document page.

§cache: &'static str

The cache policy.

§stale_ok: &'static str

The request to answer from the snapshot alone.

§watch: &'static str

The request to repeat the answer as a watch.

Implementations§

Source§

impl AxisNames

Source

pub const FLAGS: Self

How the command line spells them.

ignored names the CLI’s one --ignored value; the two specific selection values are available for diagnostics that prescribe one of them.

follow_symlinks is the one axis this surface cannot set at all, so it keeps the library’s name: a request carrying it came from a library or open caller, and naming a --follow-symlinks that does not exist would point them at the wrong door.

Source

pub const FIELDS: Self

How the library and the Python API spell them, and the default: a Query built without saying otherwise belongs to a library caller, not to the command line.

view singular, matching the label the binding already passes to ViewSpec::resolve, so every diagnostic about this axis names it one way. It also keeps the difference from the command line to the flag dashes alone, which is what the parity harness’s surface-label class checks.

cache is the one name that is not a field: the Python parameter is cache, but its refusal has always said invalid cache policy, and this type moved the wording without changing it.

Trait Implementations§

Source§

impl Clone for AxisNames

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for AxisNames

Source§

impl Debug for AxisNames

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AxisNames

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for AxisNames

Source§

impl PartialEq for AxisNames

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AxisNames

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.