Struct spectacles_model::message::Embed

pub struct Embed {
    pub title: Option<String>,
    pub kind: Option<String>,
    pub description: Option<String>,
    pub url: Option<String>,
    pub timestamp: Option<DateTime<Utc>>,
    pub color: Option<i32>,
    pub footer: Option<EmbedFooter>,
    pub image: Option<EmbedImage>,
    pub thumbnail: Option<EmbedThumbnail>,
    pub video: Option<EmbedVideo>,
    pub provider: Option<EmbedProvider>,
    pub author: Option<EmbedAuthor>,
    pub fields: Vec<EmbedField>,
}

Represents a Message Embed being sent.

Fields

title: Option<String>

The title of the embed.

kind: Option<String>

The type of embed.

description: Option<String>

The description of the embed.

url: Option<String>

The URL of the embed.

timestamp: Option<DateTime<Utc>>

The timestamp of the embed.

color: Option<i32>

The color of the embed.

footer: Option<EmbedFooter>

Information about the embed's footer.

image: Option<EmbedImage>

Information about the embed's image.

thumbnail: Option<EmbedThumbnail>

Information about the embed's thumbnail.

video: Option<EmbedVideo>

Information about an embed's video, if applicable.

provider: Option<EmbedProvider>

Information about an embed's provider if applicable.

author: Option<EmbedAuthor>

Information about the embed's author.

fields: Vec<EmbedField>

Information about the embed's fields.

Methods

impl Embed

pub fn new() -> Self

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

Sets the title for this embed.

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

Sets the description of this embed.

pub fn set_color(self, code: i32) -> Self

Sets the color of this embed.

pub fn add_field<F: FnOnce(EmbedField) -> EmbedField>(self, builder: F) -> Self

Adds a field to this embed.

pub fn set_author<F>(self, author: F) -> Self where
    F: FnOnce(EmbedAuthor) -> EmbedAuthor, 

Sets the author of this embed.

pub fn set_footer<F>(self, footer: F) -> Self where
    F: FnOnce(EmbedFooter) -> EmbedFooter, 

Sets the footer of this embed.

pub fn set_thumbnail<T>(self, thumb: T) -> Self where
    T: FnOnce(EmbedThumbnail) -> EmbedThumbnail, 

Adds a thumbnail to this embed.

pub fn set_image<F>(self, img: F) -> Self where
    F: FnOnce(EmbedImage) -> EmbedImage, 

Adds an image to this embed.

pub fn set_current_timestamp(self) -> Self

pub fn set_timestamp(self, time: DateTime<Utc>) -> Self

Trait Implementations

impl MessageResponse for Embed

fn as_message(self) -> CreateMessageOptions

impl Clone for Embed

fn clone(&self) -> Embed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Embed

fn default() -> Embed

Returns the "default value" for a type.

impl Debug for Embed

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

Formats the value using the given formatter.

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.

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.