Struct CommandArgument

pub struct CommandArgument {
    pub title: String,
    pub description: String,
    pub key: String,
    pub arg_type: ArgumentType,
    pub options: Option<Vec<ArgumentOption>>,
}

A user provided argument to a plugin command.

Fields

title: String

A human readable name for this argument, for use as placeholder text or equivelant.

description: String

A short (single sentence) description of this argument’s use.

key: String

arg_type: ArgumentType

options: Option<Vec<ArgumentOption>>

If arg_type is Choice, options must contain a list of options.

Implementations

impl CommandArgument

pub fn new<S: AsRef<str>>( title: S, description: S, key: S, arg_type: ArgumentType, options: Option<Vec<ArgumentOption>>, ) -> Self

Trait Implementations

impl Clone for CommandArgument

fn clone(&self) -> CommandArgument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArgument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandArgument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CommandArgument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.