Trait parkour::prelude::FromInputValue

pub trait FromInputValue: Sized {
    type Context;
    fn from_input_value(
        value: &str, 
        context: &Self::Context
    ) -> Result<Self, Error>;

    fn allow_leading_dashes(_context: &Self::Context) -> bool { ... }
}

Trait for parsing a value. A value can be

• a positional argument
• a string following a flag; e.g in --foo bar or --foo=bar, the bar part is a value. A flag can be followed by multiple values, e.g. --foo bar baz or --foo=bar,baz

To parse values, they are first converted to a string slice. By default, an argument that starts with a dash can't be parsed as a value, unless you implement the allow_leading_dashes method.

Associated Types

type Context

Information that is available while parsing

Loading content...

Required methods

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

The function that parses the string. This function is usually not invoked directly. Instead you can use Parse::parse_value and Parse::try_parse_value:

let mut input = parkour::parser();
let n: i32 = input.parse_value(&NumberCtx { min: -1000, max: 1000 })?;

Loading content...

Provided methods

fn allow_leading_dashes(_context: &Self::Context) -> bool

This function specifies whether this argument may start with leading dashes. For example, this returns true for numbers that can be negative. The default is false.

Loading content...

Implementations on Foreign Types

impl<T: FromInputValue, const N: usize> FromInputValue for [T; N]

type Context = ArrayCtx<T::Context>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl FromInputValue for bool

type Context = ()

fn from_input_value(value: &str, _: &()) -> Result<Self, Error>

impl FromInputValue for char

type Context = ()

fn from_input_value(value: &str, _: &()) -> Result<Self, Error>

impl<T: FromInputValue<Context = C>, C> FromInputValue for Vec<T>

type Context = ListCtx<C>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T: FromInputValue<Context = C>, C> FromInputValue for VecDeque<T>

type Context = ListCtx<C>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T: FromInputValue<Context = C>, C> FromInputValue for LinkedList<T>

type Context = ListCtx<C>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T: FromInputValue<Context = C> + Ord, C> FromInputValue for BTreeSet<T>

type Context = ListCtx<C>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T: FromInputValue<Context = C> + Hash + Eq, C> FromInputValue for HashSet<T>

type Context = ListCtx<C>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl FromInputValue for i8

type Context = NumberCtx<i8>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for i16

type Context = NumberCtx<i16>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for i32

type Context = NumberCtx<i32>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for i64

type Context = NumberCtx<i64>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for i128

type Context = NumberCtx<i128>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for isize

type Context = NumberCtx<isize>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroI8

type Context = NumberCtx<NonZeroI8>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroI16

type Context = NumberCtx<NonZeroI16>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroI32

type Context = NumberCtx<NonZeroI32>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroI64

type Context = NumberCtx<NonZeroI64>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroI128

type Context = NumberCtx<NonZeroI128>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for NonZeroIsize

type Context = NumberCtx<NonZeroIsize>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for u8

type Context = NumberCtx<u8>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for u16

type Context = NumberCtx<u16>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for u32

type Context = NumberCtx<u32>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for u64

type Context = NumberCtx<u64>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for u128

type Context = NumberCtx<u128>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for usize

type Context = NumberCtx<usize>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroU8

type Context = NumberCtx<NonZeroU8>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroU16

type Context = NumberCtx<NonZeroU16>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroU32

type Context = NumberCtx<NonZeroU32>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroU64

type Context = NumberCtx<NonZeroU64>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroU128

type Context = NumberCtx<NonZeroU128>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for NonZeroUsize

type Context = NumberCtx<NonZeroUsize>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(_: &Self::Context) -> bool

impl FromInputValue for f32

type Context = NumberCtx<f32>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for f64

type Context = NumberCtx<f64>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for String

type Context = StringCtx

fn from_input_value(value: &str, context: &StringCtx) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for OsString

type Context = StringCtx

fn from_input_value(value: &str, context: &StringCtx) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for PathBuf

type Context = StringCtx

fn from_input_value(value: &str, context: &StringCtx) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl FromInputValue for Cow<'static, str>

type Context = StringCtx

fn from_input_value(value: &str, context: &StringCtx) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T1: FromInputValue> FromInputValue for (T1,)

type Context = TupleCtx<(T1::Context,)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue> FromInputValue for (T1, T2)

type Context = TupleCtx<(T1::Context, T2::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue> FromInputValue for (T1, T2, T3)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue> FromInputValue for (T1, T2, T3, T4)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue, T8: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7, T8)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context, T8::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue, T8: FromInputValue, T9: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7, T8, T9)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context, T8::Context, T9::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue, T8: FromInputValue, T9: FromInputValue, T10: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context, T8::Context, T9::Context, T10::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue, T8: FromInputValue, T9: FromInputValue, T10: FromInputValue, T11: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context, T8::Context, T9::Context, T10::Context, T11::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T1: FromInputValue, T2: FromInputValue, T3: FromInputValue, T4: FromInputValue, T5: FromInputValue, T6: FromInputValue, T7: FromInputValue, T8: FromInputValue, T9: FromInputValue, T10: FromInputValue, T11: FromInputValue, T12: FromInputValue> FromInputValue for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

type Context = TupleCtx<(T1::Context, T2::Context, T3::Context, T4::Context, T5::Context, T6::Context, T7::Context, T8::Context, T9::Context, T10::Context, T11::Context, T12::Context)>

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

impl<T: FromInputValue> FromInputValue for Box<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for Rc<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for Arc<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for Cell<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for RefCell<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for UnsafeCell<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for Mutex<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for RwLock<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: FromInputValue> FromInputValue for ManuallyDrop<T>

type Context = T::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

impl<T: ToOwned> FromInputValue for Cow<'static, T> where
    T::Owned: FromInputValue, 

type Context = <T::Owned as FromInputValue>::Context

fn from_input_value(value: &str, context: &Self::Context) -> Result<Self, Error>

fn allow_leading_dashes(context: &Self::Context) -> bool

Loading content...

Implementors

Loading content...