Struct serenity_utils::menu::MenuOptions

pub struct MenuOptions {
    pub page: usize,
    pub timeout: f64,
    pub message: Option<Message>,
    pub controls: Vec<Control>,
    pub non_blocking: bool,
}

Options to tweak a menu.

See Control for details to implement your own controls.

Fields

page: usize

The 0-indexed page number to start at.

Defaults to 0.

timeout: f64

Number of seconds to keep the menu active.

Defaults to 30.0.

message: Option<Message>

Optional message to edit.

If supplied, this message is edited instead of the bot creating a new message to display the menu. This message must be sent by the bot.

Defaults to None.

controls: Vec<Control>

The controls for the menu.

Defaults to the following:

• ◀️ -> prev_page
• ❌ -> close_menu
• ▶️ -> next_page

non_blocking: bool

Whether to add emojis in a separate task non-blocking task or not.

If set to true, addition of emojis doesn't stop the menu from working. That is, if a reaction is added to the menu message and the user reacts to it before other reactions are added, the bot will consider that reaction and act appropriately.

If set to false, no user reactions will be considered until the bot adds all reactions.

Non-blocking addition is very slightly less efficient than blocking.

Defaults to true.

Implementations

impl MenuOptions

pub fn new(
    page: usize,
    timeout: f64,
    message: Option<Message>,
    controls: Vec<Control>,
    non_blocking: bool
) -> Self

Creates a new MenuOptions object.

Trait Implementations

impl Default for MenuOptions

pub fn default() -> Self

Returns the "default value" for a type.