Struct InputText

#[non_exhaustive]
pub struct InputText {
    pub kind: ComponentType,
    pub custom_id: String,
    pub style: Option<InputTextStyle>,
    pub label: Option<String>,
    pub min_length: Option<u16>,
    pub max_length: Option<u16>,
    pub required: bool,
    pub value: Option<String>,
    pub placeholder: Option<String>,
}

An input text component for modal interactions

Discord docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: ComponentType

The component type, it will always be ComponentType::InputText.

custom_id: String

Developer-defined identifier for the input; max 100 characters

style: Option<InputTextStyle>

The InputTextStyle. Required when sending modal data.

Discord docs are wrong here; it says the field is always sent in modal submit interactions but it’s not. It’s only required when sending modal data to Discord. https://github.com/discord/discord-api-docs/issues/6141

label: Option<String>

Label for this component; max 45 characters. Required when sending modal data.

Discord docs are wrong here; it says the field is always sent in modal submit interactions but it’s not. It’s only required when sending modal data to Discord. https://github.com/discord/discord-api-docs/issues/6141

min_length: Option<u16>

Minimum input length for a text input; min 0, max 4000

max_length: Option<u16>

Maximum input length for a text input; min 1, max 4000

required: bool

Whether this component is required to be filled (defaults to true)

value: Option<String>

When sending: Pre-filled value for this component; max 4000 characters (may be None).

When receiving: The input from the user (always Some)

placeholder: Option<String>

Custom placeholder text if the input is empty; max 100 characters

Trait Implementations

impl Clone for InputText

fn clone(&self) -> InputText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputText

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputText

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InputText

fn eq(&self, other: &InputText) -> 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 Serialize for InputText

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InputText