[−][src]Struct serenity::model::channel::Embed
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]
pub fn fake<F>(f: F) -> Value where
F: FnOnce(&mut CreateEmbed) -> &mut CreateEmbed,
[src]
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
[src]
impl Debug for Embed
[src]
impl<'de> Deserialize<'de> for Embed
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl From<Embed> for CreateEmbed
[src]
fn from(embed: Embed) -> Self
[src]
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
[src]
Auto Trait Implementations
impl RefUnwindSafe for Embed
impl Send for Embed
impl Sync for Embed
impl Unpin for Embed
impl UnwindSafe for Embed
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CloneAny for T where
T: Clone + Any,
[src]
T: Clone + Any,
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
[src]
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
[src]
T: Send,
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
[src]
T: Sync,
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
[src]
T: Send + Sync,
impl<T> DebugAny for T where
T: Any + Debug,
[src]
T: Any + Debug,
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> UnsafeAny for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,