Struct twilight_interactions::command::CommandInputData

pub struct CommandInputData<'a> {
    pub options: Vec<CommandDataOption>,
    pub resolved: Option<Cow<'a, CommandInteractionDataResolved>>,
}

Data sent by Discord when receiving a command.

This type is used in the CommandModel trait. It can be initialized from a CommandData using the From trait.

Fields

options: Vec<CommandDataOption>

resolved: Option<Cow<'a, CommandInteractionDataResolved>>

Implementations

impl<'a> CommandInputData<'a>

pub fn parse_field<T>(&self, name: &str) -> Result<Option<T>, ParseError> where
    T: CommandOption, 

Parse a field from the command data.

This method can be used to manually parse a field from raw data, for example with guild custom commands. The method return None if the field is not present instead of returning an error.

Example

use twilight_interactions::command::CommandInputData;

// `options` is a Vec<CommandDataOption>
let data = CommandInputData { options, resolved: None };
let message = data.parse_field::<String>("message").unwrap();

assert_eq!(message, Some("Hello world".to_string()));

pub fn focused(&self) -> Option<&str>

Get the name of the focused field.

This method is useful when parsing commands with multiple autocomplete fields.

Example

use twilight_interactions::command::CommandInputData;

// `options` is a Vec<CommandDataOption>
let data = CommandInputData { options, resolved: None };

assert_eq!(data.focused(), Some("message"));

pub fn from_option(
    value: CommandOptionValue,
    resolved: Option<&'a CommandInteractionDataResolved>
) -> Result<Self, ParseOptionErrorType>

Parse a subcommand CommandOptionValue.

This method signature is the same as the CommandOption trait, except the explicit 'a lifetime. It is used when parsing subcommands.

Trait Implementations

impl<'a> Clone for CommandInputData<'a>

fn clone(&self) -> CommandInputData<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommandInputData<'a>

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

Formats the value using the given formatter.

impl From<CommandData> for CommandInputData<'_>

fn from(data: CommandData) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<CommandInputData<'a>> for CommandInputData<'a>

fn eq(&self, other: &CommandInputData<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CommandInputData<'a>) -> bool

This method tests for !=.

impl<'a> Eq for CommandInputData<'a>

impl<'a> StructuralEq for CommandInputData<'a>

impl<'a> StructuralPartialEq for CommandInputData<'a>