Struct FlagSource 

pub struct FlagSource { /* private fields */ }

Collect input from a CLI flag.

This source reads a boolean flag value. It is always available since flags have a default value of false.

Example

use standout_input::{InputChain, FlagSource};

// For: myapp --verbose
let chain = InputChain::<bool>::new()
    .try_source(FlagSource::new("verbose"));

Implementations

impl FlagSource

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

Create a new flag source.

The name should match the flag name defined in clap.

pub fn inverted(self) -> Self

Invert the flag value.

Useful for patterns like --no-editor where the flag being set means “don’t use editor” (i.e., false for “use editor”).

pub fn flag_name(&self) -> &str

Get the flag name.

impl FlagSource

Resolve a flag source to a ResolvedInput.

pub fn resolve( &self, matches: &ArgMatches, ) -> Result<ResolvedInput<bool>, InputError>

Resolve the flag, returning metadata about the source.

Trait Implementations

impl Clone for FlagSource

fn clone(&self) -> FlagSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSource

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

Formats the value using the given formatter.

impl InputCollector<bool> for FlagSource

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<bool>, 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.