Skip to main content

Finding

Enum Finding 

Source
pub enum Finding {
    UnknownArg {
        arg: String,
        did_you_mean: Option<String>,
    },
    UnknownEnv {
        name: String,
        did_you_mean: String,
    },
    MissingValue {
        arg: String,
    },
    UnexpectedValue {
        arg: String,
    },
    InvalidValue {
        key: String,
        source: Source,
        value: String,
        reason: String,
    },
    UnknownToken {
        key: String,
        token: String,
        allowed: Vec<String>,
    },
    MissingRequired {
        key: String,
        via: Vec<String>,
    },
    Deprecated {
        key: String,
        guidance: String,
    },
}
Expand description

Something wrong with an invocation, relative to the declared contract.

Variants§

§

UnknownArg

A flag was given that no input declares.

Fields

§arg: String

The flag as written, dashes included.

§did_you_mean: Option<String>

The declared flag it most likely meant.

§

UnknownEnv

A variable is set that no input declares, but which closely resembles one that exists.

Only near-misses are reported: an environment holds hundreds of unrelated variables, and a checker that mentions PATH is a checker nobody runs.

Fields

§name: String

The variable that is set.

§did_you_mean: String

The declared name it most likely meant.

§

MissingValue

A flag that takes a value was given none.

Fields

§arg: String

The flag as written.

§

UnexpectedValue

A flag that takes no value was given one.

Fields

§arg: String

The flag as written.

§

InvalidValue

A declared input received a value outside its domain.

Fields

§key: String

The input’s key.

§source: Source

Where the offending value came from.

§value: String

The offending raw value.

§reason: String

Why it was rejected.

§

UnknownToken

A token in a list value is not among the declared tokens.

Fields

§key: String

The input’s key.

§token: String

The offending token.

§allowed: Vec<String>

The tokens that are accepted.

§

MissingRequired

A required input was not supplied and has no default.

Fields

§key: String

The input’s key.

§via: Vec<String>

How it could have been supplied.

§

Deprecated

A deprecated input is in use.

Fields

§key: String

The input’s key.

§guidance: String

Guidance carried by the declaration.

Implementations§

Source§

impl Finding

Source

pub fn severity(&self) -> Severity

How seriously to take this finding.

Trait Implementations§

Source§

impl Clone for Finding

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 Debug for Finding

Source§

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

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

impl Display for Finding

Source§

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

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

impl PartialEq for Finding

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 Finding

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.