Struct EmbedFieldBuilder

pub struct EmbedFieldBuilder(/* private fields */);

Available on crate feature builder only.

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 fn new(name: impl Into<String>, value: impl Into<String>) -> Self

Create a new embed field builder.

Refer to FIELD_NAME_LENGTH for the maximum number of UTF-16 code points that can be in a field name.

Refer to FIELD_VALUE_LENGTH for the maximum number of UTF-16 code points that can be in a field value.

pub fn build(self) -> EmbedField

Build into an embed field.

pub const fn inline(self) -> Self

Inline the field.

Examples

Create an inlined field:

use twilight_util::builder::embed::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 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 for EmbedFieldBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EmbedFieldBuilder

impl StructuralPartialEq for EmbedFieldBuilder