Struct twilight_builders::embed::EmbedBuilder

#[must_use =
  "The embed is not constructed. You need to call build to construct the embed."]pub struct EmbedBuilder(_);

Create an embed via a builder.

If uploading an image as an attachment, set as the image or thumbnail with attachment://{filename}.{extension}. Refer to the discord docs for more information.

Examples

A simple embed:

use twilight_builders::embed::EmbedBuilder;

let embed = EmbedBuilder::new()
    .description("Here's a list of reasons why Twilight is the best pony:")
    .add_field("Wings", "She has wings.")
        .inline()
        .commit()
    .add_field("Horn", "She can do magic, and she's really good at it.")
        .commit()
    .build();

An embed with images:

use twilight_builders::embed::EmbedBuilder;

let embed = EmbedBuilder::new()
    .description("Here's a cool image of Twilight Sparkle")
    .image("attachment://bestpony.png")
    .build();

Implementations

impl EmbedBuilder

pub fn new() -> Self

pub fn author(self) -> AuthorBuilder

Return a new AuthorBuilder.

pub fn color(self, color: u32) -> Self

Set the color.

Use hexadecimal syntax to specify an integer: 0xD4A4E8

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

Set the description.

Limited to 2048 UTF-16 code points.

pub fn add_field(
    self,
    name: impl Into<String>,
    value: impl Into<String>
) -> FieldBuilder

Add a field with a new FieldBuilder.

The name is limited to 256 UTF-16 code points, and the value is limited to 1024. The amount of fields is limited to 25.

pub fn footer(self, text: impl Into<String>) -> FooterBuilder

Return a new FooterBuilder.

The text is limited to 2048 UTF-16 code points.

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

Add an image.

Either the URL to an image or an attachment:// path.

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

Add a thumbnail.

Either the URL to an image or an attachment:// path.

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

Set the ISO 8601 timestamp.

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

Set the title.

Limited to 256 UTF-16 code points.

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

Set the URL.

pub fn build(self) -> Embed

Return an Embed.

Trait Implementations

impl Clone for EmbedBuilder

fn clone(&self) -> EmbedBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedBuilder

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

Formats the value using the given formatter.

impl Default for EmbedBuilder

fn default() -> Self

Returns the "default value" for a type.