Struct serenity_rich_interaction::menu::MenuBuilder

pub struct MenuBuilder { /* private fields */ }

A builder for messages

Implementations

impl MenuBuilder

pub fn new_paginator() -> Self

Creates a new pagination menu

pub fn add_page(self, page: Page<'static>) -> Self

Adds a page to the message builder

pub fn add_pages<I>(self, pages: I) -> Self where
    I: IntoIterator<Item = Page<'static>>, 

Adds multiple pages to the message

pub fn add_control<S, F: 'static>(
    self,
    position: isize,
    emoji: S,
    action: F
) -> Self where
    S: ToString,
    F: for<'b> Fn(&'b Context, &'b mut Menu<'_>, Reaction) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'b>> + Send + Sync, 

Adds a single control to the message

pub fn add_controls<S, I>(self, controls: I) -> Self where
    S: ToString,
    I: IntoIterator<Item = (isize, S, ControlActionArc)>, 

Adds a single control to the message

pub fn timeout(self, timeout: Duration) -> Self

Sets the timeout for the message

pub fn start_page(self, page: usize) -> Self

Sets the start page of the message

pub fn sticky(self, value: bool) -> Self

If the message should be sticky and always be the last one in the channel

pub fn add_data<T>(self, value: T::Value) -> Self where
    T: TypeMapKey, 

Adds data to the menu typemap

pub fn add_help<S: ToString>(self, button: S, help: S) -> Self

Adds a help entry

pub fn show_help(self) -> Self

Turns showing help for buttons on

pub fn owner(self, user_id: UserId) -> Self

Sets the owner of the menu if it’s set only the owner can interact with the menu

pub async fn build(
    self,
    ctx: &Context,
    channel_id: ChannelId
) -> Result<Arc<RwLock<MessageHandle>>>

builds the menu

Trait Implementations

impl Default for MenuBuilder

fn default() -> Self

Returns the “default value” for a type.