Enum ParameterSource 

#[non_exhaustive]
pub enum ParameterSource {
    CommandLine,
    Environment,
    Default,
    DefaultMap,
    Prompt,
}

Indicates the source of a parameter’s value.

Use [Context::get_parameter_source] to get the source for a parameter by name.

Precedence

Sources have a defined precedence order (highest to lowest):

1. CommandLine - Explicit user input
2. Environment - Environment variables
3. DefaultMap - Context default map
4. Default - Parameter default value

Prompt is considered equal to CommandLine for precedence since both represent direct user input.

Example

use click::ParameterSource;

let source = ParameterSource::CommandLine;
assert!(source.is_from_user());

let env_source = ParameterSource::Environment;
assert!(!env_source.is_from_user());

// CommandLine has higher precedence than Environment
assert!(ParameterSource::CommandLine > ParameterSource::Environment);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CommandLine

The value was provided by command line arguments.

Environment

The value was provided via an environment variable.

Default

The value used the default specified by the parameter.

DefaultMap

The value used a default provided by the context’s default_map.

Prompt

The value was provided via an interactive prompt.

Implementations

impl ParameterSource

pub fn is_from_user(&self) -> bool

Returns true if the value came from direct user input.

This returns true for CommandLine and Prompt, as both represent values explicitly provided by the user during execution.

Example

use click::ParameterSource;

assert!(ParameterSource::CommandLine.is_from_user());
assert!(ParameterSource::Prompt.is_from_user());
assert!(!ParameterSource::Environment.is_from_user());
assert!(!ParameterSource::Default.is_from_user());
assert!(!ParameterSource::DefaultMap.is_from_user());

Trait Implementations

impl Clone for ParameterSource

fn clone(&self) -> ParameterSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParameterSource

impl Debug for ParameterSource

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

Formats the value using the given formatter.

impl Display for ParameterSource

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

Formats the value using the given formatter.

impl Eq for ParameterSource

impl Hash for ParameterSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ParameterSource

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ParameterSource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ParameterSource

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ParameterSource