Struct ArgSource 

pub struct ArgSource { /* private fields */ }

Collect input from a CLI argument.

This source reads a string value from a clap argument. It is available when the argument was provided by the user.

Example

use standout_input::{InputChain, ArgSource};

// For: myapp --message "hello"
let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("message"));

Implementations

impl ArgSource

pub fn new(name: impl Into<String>) -> Self

Create a new argument source.

The name should match the argument name defined in clap.

pub fn arg_name(&self) -> &str

Get the argument name.

Trait Implementations

impl Clone for ArgSource

fn clone(&self) -> ArgSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgSource

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

Formats the value using the given formatter.

impl InputCollector<String> for ArgSource

fn name(&self) -> &'static str

Human-readable name for this collector.

fn is_available(&self, matches: &ArgMatches) -> bool

Check if this collector can provide input in the current environment.

fn collect(&self, matches: &ArgMatches) -> Result<Option<String>, InputError>

Attempt to collect input from this source.

fn validate(&self, _value: &T) -> Result<(), String>

Validate the collected value.

fn can_retry(&self) -> bool

Whether this collector supports retry on validation failure.