Struct Command 

pub struct Command<E: From<Error> + Clone + Debug + Send + Sync + 'static, S: Debug + Clone + Send + Sync + 'static> {
    pub name: String,
    pub handle: Arc<dyn CommandHandle<(), E, S>>,
    pub error: Option<Arc<dyn CommandErrorHandler<E, S>>>,
    pub children: HashMap<String, Command<E, S>>,
    pub checks: Vec<Arc<dyn Check<E, S>>>,
    pub aliases: Vec<String>,
    pub description: Option<String>,
    pub signature: Option<String>,
    pub parents: Vec<String>,
    pub hidden: bool,
}

Fields

name: String

handle: Arc<dyn CommandHandle<(), E, S>>

error: Option<Arc<dyn CommandErrorHandler<E, S>>>

children: HashMap<String, Command<E, S>>

checks: Vec<Arc<dyn Check<E, S>>>

aliases: Vec<String>

description: Option<String>

signature: Option<String>

parents: Vec<String>

hidden: bool

Implementations

impl<E: From<Error> + Clone + Debug + Send + Sync + 'static, S: Debug + Clone + Send + Sync + 'static> Command<E, S>

pub fn new<T: Send + Sync + 'static, I: Into<String>, F: CommandHandle<T, E, S> + Clone>( name: I, handle: F, ) -> Self

Examples found in repository

examples/commands.rs (line 67)

async fn main() -> Result<(), Error> {
    let commands = CommandHandler::new(Commands, ())
        .register(vec![Command::new("ping", ping).description("Pong")]);

    let events = Events(commands);

    Client::new(events).await?.run("TOKEN HERE").await
}

examples/groups/commands/ban.rs (line 41)

pub fn command() -> Command<Error, ()> {
    Command::new("ban", ban)
        .description("Bans a member.")
        .signature("<member> [reason...]")
        .check(server_only)
        .child(
            Command::new("remove", remove_ban)
                .description("Unbans a member.")
                .signature("<user_id>")
                .check(server_only),
        )
}

pub fn child(self, command: Self) -> Self

Examples found in repository

examples/groups/commands/ban.rs (lines 45-50)

pub fn command() -> Command<Error, ()> {
    Command::new("ban", ban)
        .description("Bans a member.")
        .signature("<member> [reason...]")
        .check(server_only)
        .child(
            Command::new("remove", remove_ban)
                .description("Unbans a member.")
                .signature("<user_id>")
                .check(server_only),
        )
}

pub fn error<H: CommandErrorHandler<E, S> + 'static>(self, handler: H) -> Self

pub fn description<I: Into<String>>(self, description: I) -> Self

Examples found in repository

examples/commands.rs (line 67)

async fn main() -> Result<(), Error> {
    let commands = CommandHandler::new(Commands, ())
        .register(vec![Command::new("ping", ping).description("Pong")]);

    let events = Events(commands);

    Client::new(events).await?.run("TOKEN HERE").await
}

examples/groups/commands/ban.rs (line 42)

pub fn command() -> Command<Error, ()> {
    Command::new("ban", ban)
        .description("Bans a member.")
        .signature("<member> [reason...]")
        .check(server_only)
        .child(
            Command::new("remove", remove_ban)
                .description("Unbans a member.")
                .signature("<user_id>")
                .check(server_only),
        )
}

pub fn signature<I: Into<String>>(self, signature: I) -> Self

Examples found in repository

examples/groups/commands/ban.rs (line 43)

pub fn command() -> Command<Error, ()> {
    Command::new("ban", ban)
        .description("Bans a member.")
        .signature("<member> [reason...]")
        .check(server_only)
        .child(
            Command::new("remove", remove_ban)
                .description("Unbans a member.")
                .signature("<user_id>")
                .check(server_only),
        )
}

pub fn check<C: Check<E, S>>(self, check: C) -> Self

Examples found in repository

examples/groups/commands/ban.rs (line 44)

pub fn command() -> Command<Error, ()> {
    Command::new("ban", ban)
        .description("Bans a member.")
        .signature("<member> [reason...]")
        .check(server_only)
        .child(
            Command::new("remove", remove_ban)
                .description("Unbans a member.")
                .signature("<user_id>")
                .check(server_only),
        )
}

pub fn alias<I: Into<String>>(self, alias: I) -> Self

pub fn hidden(self) -> Self

pub fn children(&self) -> Vec<Command<E, S>>

pub fn get_command(&self, name: &str) -> Option<Command<E, S>>

pub async fn can_run(&self, context: Context<E, S>) -> Result<bool, E>

pub async fn invoke(&self, context: Context<E, S>) -> Result<(), E>

Trait Implementations

impl<E: Clone + From<Error> + Clone + Debug + Send + Sync + 'static, S: Clone + Debug + Clone + Send + Sync + 'static> Clone for Command<E, S>

fn clone(&self) -> Command<E, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: From<Error> + Clone + Debug + Send + Sync + 'static, S: Debug + Clone + Send + Sync + 'static> Debug for Command<E, S>

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

Formats the value using the given formatter.