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

Create a new default embed field builder.

Refer to EmbedBuilder::FIELD_NAME_LENGTH_LIMIT for the maximum number of UTF-16 code poitns that can be in a field name.

Refer to EmbedBuilder::FIELD_VALUE_LENGTH_LIMIT for the maximum number of UTF-16 code poitns that can be in a field value.

#[must_use = "should be used as part of an embed builder"]

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_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 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 Eq for EmbedFieldBuilder

impl StructuralEq for EmbedFieldBuilder

impl StructuralPartialEq for EmbedFieldBuilder