👎 Deprecated since 0.10.1:

use twilight_util::builder::embed

Expand description

twilight-embed-builder

codecov badge discord badge github badge license badge rust badge

twilight-embed-builder is a set of builder for the twilight-rs ecosystem to create a message embed, useful when creating or updating messages.

Examples

Build a simple embed:

use twilight_embed_builder::{EmbedBuilder, EmbedFieldBuilder};

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

Build an embed with an image:

use twilight_embed_builder::{EmbedBuilder, ImageSource};

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

Re-exports

pub use self::image_source::ImageSource;
Deprecated

Modules

image_sourceDeprecated

Sources to image URLs and attachments.

Structs

Create an embed author with a builder.

EmbedBuilderDeprecated

Create an embed with a builder.

EmbedErrorDeprecated

Error building an embed.

Create an embed field with a builder.

Create an embed footer with a builder.

Enums

EmbedErrorTypeDeprecated

Type of EmbedError that occurred.