Struct brigadier_rs::parsers::NumberArgument

pub struct NumberArgument<N, S> { /* private fields */ }

Numeric argument parser.

This type can be bounded between a minimum and maximum value (standard MIN and MAX of type N). A parse method for type N must be provided also.

Implementations

impl<N, S> NumberArgument<N, S>where
    N: PartialOrd,

pub fn min(self, min: N) -> Self

Set a minimum value for this argument (inclusive).

pub fn max(self, max: N) -> Self

Set a maximum value for this argument (inclusive).

Trait Implementations

impl<N, S> ChildUsage for NumberArgument<N, S>

type Child = [&'static str; 3]

Usage that is returned.

fn usage_child(&self) -> Self::Child

Return a new SingleUsage, this represents the path from the root up until this parser.

impl<S, N> CommandArgument<S, N> for NumberArgument<N, S>where
    N: PartialOrd,

fn parse<'a>(
    &self,
    _source: S,
    input: &'a str
) -> IResult<&'a str, N, CommandError<'a>>

This implementation may return a Failure when the parsed number is outside of the bounds.

impl<N, S> IntoMultipleUsage for NumberArgument<N, S>

type Item = <[&'static str; 3] as IntoMultipleUsage>::Item

The returned MultipleUsage iterator.

fn usage_gen(&self) -> Self::Item

Return a new MultipleUsage based on self (without consuming self).

impl<E, N, S> Then<E> for NumberArgument<N, S>

type Output = CommandThen<NumberArgument<N, S>, E, N, S>

Branching parser used by this type.

fn then(self, executor: E) -> Self::Output

Returns the braching parser Self::Output initialized with self and a child argument.

impl<N, S> ArgumentMarkerDefaultImpl for NumberArgument<N, S>