Struct twilight_embed_builder::footer::EmbedFooterBuilder

#[must_use = "must be built into an embed footer"]pub struct EmbedFooterBuilder(_);

Create an embed footer with a builder.

This can be passed into EmbedBuilder::footer.

Implementations

impl EmbedFooterBuilder

pub const TEXT_LENGTH_LIMIT: usize

The maximum number of UTF-16 code points that can be in a footer's text.

pub fn new(text: impl Into<String>) -> Result<Self, EmbedFooterTextError>

Create a new default embed footer builder.

Refer to TEXT_LENGTH_LIMIT for the maximum number of UTF-16 code points that can be in a footer's text.

Errors

Returns EmbedFooterTextError::Empty if the provided text is empty.

Returns EmbedFooterTextError::TooLong if the provided text is longer than the limit defined at TEXT_LENGTH_LIMIT.

#[must_use = "should be used as part of an embed builder"]pub fn build(self) -> EmbedFooter

Build into an embed footer.

pub fn icon_url(self, image_source: ImageSource) -> Self

Add a footer icon.

Examples

Create a footer by Twilight with a URL to an image of its logo:

use twilight_embed_builder::{EmbedFooterBuilder, ImageSource};

let icon_url = ImageSource::url("https://raw.githubusercontent.com/twilight-rs/twilight/trunk/logo.png")?;
let footer = EmbedFooterBuilder::new("Twilight")?
    .icon_url(icon_url)
    .build();

Trait Implementations

impl Clone for EmbedFooterBuilder

fn clone(&self) -> EmbedFooterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedFooterBuilder

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

Formats the value using the given formatter.

impl Eq for EmbedFooterBuilder

impl From<EmbedFooterBuilder> for EmbedFooter

fn from(builder: EmbedFooterBuilder) -> Self

Convert an embed footer builder into an embed footer.

This is equivalent to calling EmbedFooterBuilder::build.

impl PartialEq<EmbedFooterBuilder> for EmbedFooterBuilder

fn eq(&self, other: &EmbedFooterBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EmbedFooterBuilder) -> bool

This method tests for !=.

impl StructuralEq for EmbedFooterBuilder

impl StructuralPartialEq for EmbedFooterBuilder