Struct twilight_embed_builder::field::EmbedFieldBuilder

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

Create an embed field with a builder.

This can be passed into EmbedBuilder::field.

Fields are not inlined by default. Use inline to inline a field.

Implementations

impl EmbedFieldBuilder

pub const NAME_LENGTH_LIMIT: usize

The maximum number of UTF-16 code points that can be in a field name.

This is used by new.

pub const VALUE_LENGTH_LIMIT: usize

The maximum number of UTF-16 code points that can be in a field value.

This is used by new.

pub fn new(
    name: impl Into<String>,
    value: impl Into<String>
) -> Result<Self, EmbedFieldError>

Create a new default embed field builder.

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

Errors

Returns EmbedFieldError::NameEmpty if the provided name is empty.

Returns EmbedFieldError::NameTooLong if the provided name is longer than 256 UTF-16 code points.

Returns EmbedFieldError::ValueEmpty if the provided value is empty.

Returns EmbedFieldError::ValueTooLong if the provided value is longer than 1024 UTF-16 code points.

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

Build into an embed field.

pub fn inline(self) -> Self

Inline the field.

Examples

Create an inlined field:

use twilight_embed_builder::EmbedFieldBuilder;

let field = EmbedFieldBuilder::new("twilight", "is cool")?
    .inline()
    .build();

Trait Implementations

impl Clone for EmbedFieldBuilder

fn clone(&self) -> EmbedFieldBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedFieldBuilder

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

Formats the value using the given formatter.

impl Eq for EmbedFieldBuilder

impl From<EmbedFieldBuilder> for EmbedField

fn from(builder: EmbedFieldBuilder) -> Self

Convert an embed field builder into an embed field.

This is equivalent to calling EmbedFieldBuilder::build.

impl PartialEq<EmbedFieldBuilder> for EmbedFieldBuilder

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

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

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

This method tests for !=.

impl StructuralEq for EmbedFieldBuilder

impl StructuralPartialEq for EmbedFieldBuilder