Struct slashy::framework::CommandContext

pub struct CommandContext {
    pub ctx: Context,
    // some fields omitted
}

The context sent to a command’s function Holds arguments, source and Serenity context

Fields

ctx: Context

The Serenity context that was with the event

Implementations

impl CommandContext

pub fn get_arg<'a>(&'a self, key: &str) -> Option<&'a Argument>

Gets an argument

pub fn get_str_arg<'a>(&'a self, key: &str) -> Option<&'a String>

Gets the value of a String argument

pub fn get_int_arg<'a>(&'a self, key: &str) -> Option<&'a i32>

Gets the value of a Integer argument

pub fn get_bool_arg<'a>(&'a self, key: &str) -> Option<&'a bool>

Gets the value of a Boolean argument

pub fn get_user_arg<'a>(&'a self, key: &str) -> Option<&'a UserId>

Gets the value of a User argument

pub fn get_channel_arg<'a>(&'a self, key: &str) -> Option<&'a ChannelId>

Gets the value of a Channel argument

pub fn get_role_arg<'a>(&'a self, key: &str) -> Option<&'a RoleId>

Gets the value of a Role argument

pub fn author(&self) -> Option<User>

Gets the User that triggered the command

pub async fn send_str(&self, content: &str) -> Result<()>

Sends a string in the channel the command was triggered in

pub async fn send_embed<F>(&self, embed: F) -> Result<()> where
    F: Fn(&mut CreateEmbed) -> &mut CreateEmbed, 

Sends a message to the channel the command was triggered in

For Message this is just a wrapper around send_message

For Interaction this sends a ChannelMessageWithSource

Note, we have content be an Option<&str> instead of using a CreateMessage callback as interaction responses use different create message types

pub async fn send_message<'a, F>(&self, f: F) -> Result<Message> where
    F: FnOnce(&'b mut CreateMessage<'a>) -> &'b mut CreateMessage<'a>, 

Sends a message to the channel the CommandSource is from

pub async fn member(&self) -> Result<Member>

Gets the member who triggered the command

pub async fn guild(&self) -> Result<PartialGuild>

Gets the guild the command was triggered in

pub fn guild_id(&self) -> Option<GuildId>

Gets the guild id the command was triggered in

pub async fn channel(&self) -> Result<Channel>

Gets the channel the command was triggered in

Trait Implementations

impl Debug for CommandContext

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

Formats the value using the given formatter.