Struct twilight_embed_builder::author::EmbedAuthorBuilder

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

Create an embed author with a builder.

This can be passed into EmbedBuilder::author.

Implementations

impl EmbedAuthorBuilder

pub const NAME_LENGTH_LIMIT: usize

The maximum number of UTF-16 code points that can be in an author name.

This is used by name.

pub fn new() -> Self

Create a new default embed author builder.

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

Build into an embed author.

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

Add an author icon.

pub fn name(self, name: impl Into<String>) -> Result<Self, EmbedAuthorNameError>

The author's name.

Refer to NAME_LENGTH_LIMIT for the maximum number of UTF-16 code points that can be in a description.

Errors

Returns EmbedAuthorNameError::Empty if the provided name is empty.

Returns EmbedAuthorNameError::TooLong if the provided name is longer than the maximum number of code points.

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

The author's url.

Trait Implementations

impl Clone for EmbedAuthorBuilder

fn clone(&self) -> EmbedAuthorBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedAuthorBuilder

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

Formats the value using the given formatter.

impl Default for EmbedAuthorBuilder

fn default() -> Self

Returns the "default value" for a type.

impl Eq for EmbedAuthorBuilder

impl From<EmbedAuthorBuilder> for EmbedAuthor

fn from(builder: EmbedAuthorBuilder) -> Self

Convert an embed author builder into an embed author.

This is equivalent to calling EmbedAuthorBuilder::build.

impl PartialEq<EmbedAuthorBuilder> for EmbedAuthorBuilder

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

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

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

This method tests for !=.

impl StructuralEq for EmbedAuthorBuilder

impl StructuralPartialEq for EmbedAuthorBuilder