Struct teloxide::utils::command::CommandDescriptions

pub struct CommandDescriptions<'a> { /* private fields */ }

Command descriptions that can be shown to the user (e.g. as a part of /help message)

Most of the time you don’t need to create this struct yourself as it’s returned from BotCommands::descriptions.

Implementations

impl<'a> CommandDescriptions<'a>

pub const fn new(descriptions: &'a [CommandDescription<'a>]) -> Self

Creates new CommandDescriptions from a list of command descriptions.

pub fn global_description(self, global_description: &'a str) -> Self

Sets the global description of these commands.

pub fn username(self, bot_username: &'a str) -> Self

Sets the username of the bot.

After this method is called, returned instance of CommandDescriptions will append @bot_username to all commands. This is useful in groups, to disambiguate commands for different bots.

Examples

use teloxide::utils::command::{CommandDescription, CommandDescriptions};

let descriptions = CommandDescriptions::new(&[
    CommandDescription { prefix: "/", command: "start", description: "start this bot" },
    CommandDescription { prefix: "/", command: "help", description: "show this message" },
]);

assert_eq!(descriptions.to_string(), "/start — start this bot\n/help — show this message");
assert_eq!(
    descriptions.username("username_of_the_bot").to_string(),
    "/start@username_of_the_bot — start this bot\n/help@username_of_the_bot — show this \
     message"
);

pub fn username_from_me(self, me: &'a Me) -> CommandDescriptions<'a>

Sets the username of the bot.

This is the same as username, but uses value returned from get_me method to get the username.

Trait Implementations

impl<'a> Clone for CommandDescriptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommandDescriptions<'a>

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

Formats the value using the given formatter.

impl Display for CommandDescriptions<'_>

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

Formats the value using the given formatter.