Struct serenity::model::Embed
[−]
[src]
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
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 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 [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 [kind
] is "video"
.
Methods
impl Embed
[src]
fn fake<F>(f: F) -> Value where
F: FnOnce(CreateEmbed) -> CreateEmbed,
F: FnOnce(CreateEmbed) -> 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::Embed; let embed = Embed::fake(|e| e .title("Embed title") .description("Making a basic embed") .field(|f| f .name("A field") .value("Has some content.") .inline(false)));
Trait Implementations
impl Clone for Embed
[src]
fn clone(&self) -> Embed
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more