clap::builder

Trait ValueParserFactory

Source
pub trait ValueParserFactory {
    type Parser;

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

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§

Source

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§

Source

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§

Source§

impl ValueParserFactory for bool

Source§

impl ValueParserFactory for i8

Source§

impl ValueParserFactory for i16

Source§

impl ValueParserFactory for i32

Source§

impl ValueParserFactory for i64

Source§

impl ValueParserFactory for u8

Source§

impl ValueParserFactory for u16

Source§

impl ValueParserFactory for u32

Source§

impl ValueParserFactory for u64

Source§

impl ValueParserFactory for Box<str>

Source§

impl ValueParserFactory for Box<OsStr>

Source§

impl ValueParserFactory for Box<Path>

Source§

impl ValueParserFactory for String

Source§

impl ValueParserFactory for OsString

Source§

impl ValueParserFactory for PathBuf

Source§

impl<T> ValueParserFactory for Box<T>

Source§

impl<T> ValueParserFactory for Arc<T>

Source§

impl<T> ValueParserFactory for Wrapping<T>

Implementors§