Struct Argument

pub struct Argument<S> {
    pub name: String,
    /* private fields */
}

An argument node type. The T type parameter is the type of the argument, which can be anything.

Fields

name: String

Implementations

impl<S> Argument<S>

pub fn new( name: &str, parser: Arc<dyn ArgumentType + Send + Sync>, custom_suggestions: Option<Arc<dyn SuggestionProvider<S> + Send + Sync>>, ) -> Self

pub fn parse( &self, reader: &mut StringReader, ) -> Result<Arc<dyn Any>, CommandSyntaxError>

pub fn list_suggestions( &self, context: CommandContext<S>, builder: SuggestionsBuilder, ) -> Suggestions

pub fn examples(&self) -> Vec<String>

Trait Implementations

impl<S> Clone for Argument<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Argument<S>

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

Formats the value using the given formatter.

impl<S> From<Argument<S>> for ArgumentBuilderType<S>

fn from(argument: Argument<S>) -> Self

Converts to this type from the input type.