Struct clap::builder::NonEmptyStringValueParser

#[non_exhaustive]
pub struct NonEmptyStringValueParser {}

Parse non-empty string values

See also:

• ValueParser::string

Example

Usage:

let mut cmd = clap::Command::new("raw")
    .arg(
        clap::Arg::new("append")
            .value_parser(clap::builder::NonEmptyStringValueParser::new())
            .required(true)
    );

let m = cmd.try_get_matches_from_mut(["cmd", "true"]).unwrap();
let port: &String = m.get_one("append")
    .expect("required");
assert_eq!(port, "true");

Semantics:

let value_parser = clap::builder::NonEmptyStringValueParser::new();
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("random")).unwrap(), "random");
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("")).is_err());

Implementations

impl NonEmptyStringValueParser

pub fn new() -> Self

Parse non-empty string values

Trait Implementations

impl Clone for NonEmptyStringValueParser

fn clone(&self) -> NonEmptyStringValueParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonEmptyStringValueParser

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

Formats the value using the given formatter.

impl Default for NonEmptyStringValueParser

fn default() -> Self

Returns the “default value” for a type.

impl TypedValueParser for NonEmptyStringValueParser

type Value = String

Argument’s value type

fn parse_ref(
    &self,
    cmd: &Command<'_>,
    arg: Option<&Arg<'_>>,
    value: &OsStr
) -> Result<Self::Value, Error>

Parse the argument value

fn parse(
    &self,
    cmd: &Command<'_>,
    arg: Option<&Arg<'_>>,
    value: OsString
) -> Result<Self::Value, Error>

Parse the argument value

fn possible_values(
    &self
) -> Option<Box<dyn Iterator<Item = PossibleValue<'static>> + '_>>

Reflect on enumerated value properties

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>where
    T: Send + Sync + Clone,
    F: Fn(Self::Value) -> T + Clone,

Adapt a TypedValueParser from one value to another

impl Copy for NonEmptyStringValueParser