Struct serenity::model::channel::Embed

#[non_exhaustive]
pub struct Embed {

    pub author: Option<EmbedAuthor>,
    pub colour: Colour,
    pub description: Option<String>,
    pub fields: Vec<EmbedField>,
    pub footer: Option<EmbedFooter>,
    pub image: Option<EmbedImage>,
    pub kind: String,
    pub provider: Option<EmbedProvider>,
    pub thumbnail: Option<EmbedThumbnail>,
    pub timestamp: Option<String>,
    pub title: Option<String>,
    pub url: Option<String>,
    pub video: Option<EmbedVideo>,
}

Represents a rich embed which allows using richer markdown, multiple fields and more. This was heavily inspired by slack’s attachments.

You can include an attachment in your own message by a user or a bot, or in a webhook.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

author: Option<EmbedAuthor>

Information about the author of the embed.

colour: Colour

The colour code of the embed.

description: Option<String>

The description of the embed.

The maximum value for this field is 2048 unicode codepoints.

fields: Vec<EmbedField>

The array of fields.

The maximum number of fields is 25.

footer: Option<EmbedFooter>

Footer information for the embed.

image: Option<EmbedImage>

Image information of the embed.

kind: String

The type of the embed. For embeds not generated by Discord’s backend, this will always be “rich”.

provider: Option<EmbedProvider>

Provider information for the embed.

For example, if the embed Self::kind is "video", the provider might contain information about YouTube.

thumbnail: Option<EmbedThumbnail>

Thumbnail information of the embed.

timestamp: Option<String>

Timestamp information.

title: Option<String>

The title of the embed.

url: Option<String>

The URL of the embed.

video: Option<EmbedVideo>

The embed’s video information.

This is present if the Self::kind is "video".

Implementations

impl Embed

pub fn fake<F>(f: F) -> Value where
    F: FnOnce(&mut CreateEmbed) -> &mut CreateEmbed, 

Creates a fake Embed, giving back a serde_json map.

This should only be useful in conjunction with Webhook::execute.

Examples

Create an embed:

use serenity::model::channel::Embed;

let embed = Embed::fake(|e| {
    e.title("Embed title")
        .description("Making a basic embed")
        .field("A field", "Has some content.", false)
});

Trait Implementations

impl Clone for Embed

fn clone(&self) -> Embed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Embed

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Embed

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Embed> for CreateEmbed

fn from(embed: Embed) -> Self

Converts the fields of an embed into the values for a new embed builder.

Some values - such as Proxy URLs - are not preserved.

impl Serialize for Embed

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

Serialize this value into the given Serde serializer.