Trait ValueParserFactory

pub trait ValueParserFactory {
    type Parser;

    // Required method
    fn value_parser() -> Self::Parser;
}

Register a type with value_parser!

Example

#[derive(Copy, Clone, Debug)]
pub struct Custom(u32);

impl clap::builder::ValueParserFactory for Custom {
    type Parser = CustomValueParser;
    fn value_parser() -> Self::Parser {
        CustomValueParser
    }
}

#[derive(Clone, Debug)]
pub struct CustomValueParser;
impl clap::builder::TypedValueParser for CustomValueParser {
    type Value = Custom;

    fn parse_ref(
        &self,
        cmd: &clap::Command,
        arg: Option<&clap::Arg>,
        value: &std::ffi::OsStr,
    ) -> Result<Self::Value, clap::Error> {
        let inner = clap::value_parser!(u32);
        let val = inner.parse_ref(cmd, arg, value)?;
        Ok(Custom(val))
    }
}

let parser: CustomValueParser = clap::value_parser!(Custom);

Required Associated Types

type Parser

Generated parser, usually ValueParser.

It should at least be a type that supports Into<ValueParser>. A non-ValueParser type allows the caller to do further initialization on the parser.

Required Methods

fn value_parser() -> Self::Parser

Create the specified Self::Parser

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ValueParserFactory for bool

type Parser = ValueParser

fn value_parser() -> Self::Parser

impl ValueParserFactory for i8

type Parser = RangedI64ValueParser<i8>

fn value_parser() -> Self::Parser

impl ValueParserFactory for i16

type Parser = RangedI64ValueParser<i16>

fn value_parser() -> Self::Parser

impl ValueParserFactory for i32

type Parser = RangedI64ValueParser<i32>

fn value_parser() -> Self::Parser

impl ValueParserFactory for i64

type Parser = RangedI64ValueParser

fn value_parser() -> Self::Parser

impl ValueParserFactory for u8

type Parser = RangedI64ValueParser<u8>

fn value_parser() -> Self::Parser

impl ValueParserFactory for u16

type Parser = RangedI64ValueParser<u16>

fn value_parser() -> Self::Parser

impl ValueParserFactory for u32

type Parser = RangedI64ValueParser<u32>

fn value_parser() -> Self::Parser

impl ValueParserFactory for u64

type Parser = RangedU64ValueParser

fn value_parser() -> Self::Parser

impl ValueParserFactory for Box<str>

type Parser = MapValueParser<StringValueParser, fn(_: String) -> Box<str>>

fn value_parser() -> Self::Parser

impl ValueParserFactory for Box<OsStr>

type Parser = MapValueParser<OsStringValueParser, fn(_: OsString) -> Box<OsStr>>

fn value_parser() -> Self::Parser

impl ValueParserFactory for Box<Path>

type Parser = MapValueParser<PathBufValueParser, fn(_: PathBuf) -> Box<Path>>

fn value_parser() -> Self::Parser

impl ValueParserFactory for String

type Parser = ValueParser

fn value_parser() -> Self::Parser

impl ValueParserFactory for OsString

type Parser = ValueParser

fn value_parser() -> Self::Parser

impl ValueParserFactory for PathBuf

type Parser = ValueParser

fn value_parser() -> Self::Parser

impl<T> ValueParserFactory for Box<T>

where T: ValueParserFactory + Send + Sync + Clone, <T as ValueParserFactory>::Parser: TypedValueParser<Value = T>,

type Parser = MapValueParser<<T as ValueParserFactory>::Parser, fn(_: T) -> Box<T>>

fn value_parser() -> Self::Parser

impl<T> ValueParserFactory for Arc<T>

where T: ValueParserFactory + Send + Sync + Clone, <T as ValueParserFactory>::Parser: TypedValueParser<Value = T>,

type Parser = MapValueParser<<T as ValueParserFactory>::Parser, fn(_: T) -> Arc<T>>

fn value_parser() -> Self::Parser

impl<T> ValueParserFactory for Wrapping<T>

where T: ValueParserFactory + Send + Sync + Clone, <T as ValueParserFactory>::Parser: TypedValueParser<Value = T>,

type Parser = MapValueParser<<T as ValueParserFactory>::Parser, fn(_: T) -> Wrapping<T>>

fn value_parser() -> Self::Parser

Implementors