1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
//! # twilight-embed-builder
//!
//! [![codecov badge][]][codecov link] [![discord badge][]][discord link] [![github badge][]][github link] [![license badge][]][license link] ![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:
//!
//! ```rust,no_run
//! use twilight_embed_builder::{EmbedBuilder, EmbedFieldBuilder};
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! 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()?;
//! # Ok(()) }
//! ```
//!
//! Build an embed with an image:
//!
//! ```rust,no_run
//! use twilight_embed_builder::{EmbedBuilder, ImageSource};
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let embed = EmbedBuilder::new()
//! .description("Here's a cool image of Twilight Sparkle")
//! .image(ImageSource::attachment("bestpony.png")?)
//! .build()?;
//!
//! # Ok(()) }
//! ```
//!
//! [`twilight-rs`]: https://github.com/twilight-rs/twilight
//! [codecov badge]: https://img.shields.io/codecov/c/gh/twilight-rs/twilight?logo=codecov&style=for-the-badge&token=E9ERLJL0L2
//! [codecov link]: https://app.codecov.io/gh/twilight-rs/twilight/
//! [discord badge]: https://img.shields.io/discord/745809834183753828?color=%237289DA&label=discord%20server&logo=discord&style=for-the-badge
//! [discord link]: https://discord.gg/7jj8n7D
//! [github badge]: https://img.shields.io/badge/github-twilight-6f42c1.svg?style=for-the-badge&logo=github
//! [github link]: https://github.com/twilight-rs/twilight
//! [license badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=for-the-badge&logo=pastebin
//! [license link]: https://github.com/twilight-rs/twilight/blob/main/LICENSE.md
//! [rust badge]: https://img.shields.io/badge/rust-1.60+-93450a.svg?style=for-the-badge&logo=rust
//! [the discord docs]: https://discord.com/developers/docs/resources/channel#create-message-using-attachments-within-embeds
#![deprecated(since = "0.10.1", note = "use twilight_util::builder::embed")]
#![deny(
clippy::all,
clippy::missing_const_for_fn,
clippy::pedantic,
future_incompatible,
missing_docs,
nonstandard_style,
rust_2018_idioms,
rustdoc::broken_intra_doc_links,
unsafe_code,
unused
)]
pub mod image_source;
mod author;
mod builder;
mod field;
mod footer;
pub use self::{
author::EmbedAuthorBuilder,
builder::{EmbedBuilder, EmbedError, EmbedErrorType},
field::EmbedFieldBuilder,
footer::EmbedFooterBuilder,
image_source::ImageSource,
};