Struct CreateEmbed

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

A builder to create an embed in a message

Discord docs

Implementations

impl CreateEmbed

pub fn new() -> Self

Equivalent to Self::default.

pub fn author(self, author: CreateEmbedAuthor) -> Self

Set the author of the embed.

Refer to the documentation for CreateEmbedAuthor for more information.

pub fn color<C: Into<Colour>>(self, colour: C) -> Self

Set the colour of the left-hand side of the embed.

This is an alias of Self::colour.

pub fn colour<C: Into<Colour>>(self, colour: C) -> Self

Set the colour of the left-hand side of the embed.

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

Set the description of the embed.

Note: This can’t be longer than 4096 characters.

pub fn field( self, name: impl Into<String>, value: impl Into<String>, inline: bool, ) -> Self

Set a field. Note that this will not overwrite other fields, and will add to them.

Note: Maximum amount of characters you can put is 256 in a field name and 1024 in a field value.

pub fn fields<N, V>( self, fields: impl IntoIterator<Item = (N, V, bool)>, ) -> Self

where N: Into<String>, V: Into<String>,

Adds multiple fields at once.

This is sugar to reduce the need of calling Self::field manually multiple times.

pub fn footer(self, footer: CreateEmbedFooter) -> Self

Set the footer of the embed.

Refer to the documentation for CreateEmbedFooter for more information.

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

Set the image associated with the embed.

Refer Discord Documentation for rules on naming local attachments.

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

Set the thumbnail of the embed.

pub fn timestamp<T: Into<Timestamp>>(self, timestamp: T) -> Self

Set the timestamp.

See the documentation of Timestamp for more information.

Examples

Passing a string timestamp:

let timestamp: Timestamp = "2004-06-08T16:04:23Z".parse().expect("Invalid timestamp!");
let embed = CreateEmbed::new().title("hello").timestamp(timestamp);

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

Set the title of the embed.

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

Set the URL to direct to when clicking on the title.

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

Same as calling Self::image with “attachment://filename.(jpg, png)”.

Note however, you have to be sure you set an attachment (with ChannelId::send_files) with the provided filename. Or else this won’t work.

Refer Self::image for rules on naming local attachments.

Trait Implementations

impl Clone for CreateEmbed

fn clone(&self) -> CreateEmbed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEmbed

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

Formats the value using the given formatter.

impl Default for CreateEmbed

fn default() -> Self

Creates a builder with default values, setting the type to rich.

impl From<Embed> for CreateEmbed

fn from(embed: Embed) -> Self

Converts to this type from the input type.

impl PartialEq for CreateEmbed

fn eq(&self, other: &CreateEmbed) -> 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 CreateEmbed

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 CreateEmbed