Skip to main content

LintPolicy

Struct LintPolicy 

Source
pub struct LintPolicy { /* private fields */ }
Expand description

How serious each kind of finding is for one program.

By default a misspelled flag, a misspelled variable and a flag given to a subcommand it does not belong to are all errors: the user’s intent is clear and wrong, and carrying on would run the program without the setting they asked for. A project that has a reason to be more forgiving says so, once, in its own code:

use argenv_resolve::{LintPolicy, Severity};

// Everything strict (this is the default):
let strict = LintPolicy::default();

// The previous behaviour: surface typos, never stop for them.
let lenient = LintPolicy::lenient();

// Or one class at a time, for example a wrapper that forwards unknown flags to a child:
let wrapper = LintPolicy::default().unknown_flags(Severity::Warning);

The findings themselves do not change with the policy, only how seriously they are taken. A problem with a value (out of domain, unparseable, missing) is always an error: there is no usable reading of it.

Implementations§

Source§

impl LintPolicy

Source

pub const fn strict() -> Self

Typos in flags and variables are errors; use of a deprecated input is a warning.

Source

pub const fn lenient() -> Self

Typos are surfaced but never stop the program. This was the behaviour before strictness became the default; it is the right choice for a program that forwards flags it does not declare, or that runs in environments it does not control.

Source

pub const fn unknown_flags(self, severity: Severity) -> Self

How seriously to take a flag that no input declares.

Source

pub const fn unknown_variables(self, severity: Severity) -> Self

How seriously to take a variable that closely resembles a declared one.

Source

pub const fn out_of_scope_flags(self, severity: Severity) -> Self

How seriously to take a flag that is declared, but for other subcommands than the one running (for example --dry-run, which belongs to create, given to delete).

Source

pub const fn deprecated(self, severity: Severity) -> Self

How seriously to take the use of a deprecated input.

Source

pub fn severity(&self, finding: &Finding) -> Severity

The severity this policy gives a finding.

Trait Implementations§

Source§

impl Clone for LintPolicy

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 LintPolicy

Source§

impl Debug for LintPolicy

Source§

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

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

impl Default for LintPolicy

Source§

fn default() -> Self

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

impl Eq for LintPolicy

Source§

impl PartialEq for LintPolicy

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 LintPolicy

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.