Struct CreateButton

pub struct CreateButton(/* private fields */);

A builder for creating a button component in a message

Implementations

impl CreateButton

pub fn new_link(url: impl Into<String>) -> Self

Creates a link button to the given URL. You must also set Self::label and/or Self::emoji after this.

Clicking this button will not trigger an interaction event in your bot.

pub fn new_premium(sku_id: impl Into<SkuId>) -> Self

Creates a new premium button associated with the given SKU.

Clicking this button will not trigger an interaction event in your bot.

pub fn new(custom_id: impl Into<String>) -> Self

Creates a normal button with the given custom ID. You must also set Self::label and/or Self::emoji after this.

pub fn custom_id(self, id: impl Into<String>) -> Self

Sets the custom id of the button, a developer-defined identifier. Replaces the current value as set in Self::new.

Has no effect on link buttons and premium buttons.

pub fn style(self, new_style: ButtonStyle) -> Self

Sets the style of this button.

Has no effect on link buttons and premium buttons.

pub fn label(self, label: impl Into<String>) -> Self

Sets label of the button.

pub fn emoji(self, emoji: impl Into<ReactionType>) -> Self

Sets emoji of the button.

pub fn disabled(self, disabled: bool) -> Self

Sets the disabled state for the button.

Trait Implementations

impl Clone for CreateButton

fn clone(&self) -> CreateButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateButton

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

Formats the value using the given formatter.

impl From<Button> for CreateButton

fn from(button: Button) -> Self

Converts to this type from the input type.

impl PartialEq for CreateButton

fn eq(&self, other: &CreateButton) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateButton

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateButton