Struct slack_blocks::blocks::input::build::InputBuilder

pub struct InputBuilder<'a, Element, Label> { /* fields omitted */ }

Build an Input block

Allows you to construct safely, with compile-time checks on required setter methods.

Required Methods

InputBuilder::build() is only available if these methods have been called:

• element

Example

use slack_blocks::{blocks::Input,
                   compose::text::ToSlackPlaintext,
                   elems::TextInput};

let block =
  Input::builder().label("foo".plaintext())
                  .element(TextInput::builder().action_id("foo").build())
                  .build();

Implementations

impl<'a, E, L> InputBuilder<'a, E, L>

pub fn new() -> Self

Create a new InputBuilder

pub fn label<T>(self, label: T) -> InputBuilder<'a, E, Set<label>> where
    T: Into<Plain>, 

Set label (Required)

A label that appears above an input element in the form of a text object 🔗 that must have type of plain_text.

Maximum length for the text in this field is 2000 characters.

pub fn block_id<S>(self, block_id: S) -> Self where
    S: Into<Cow<'a, str>>, 

Set block_id (Optional)

A string acting as a unique identifier for a block.

You can use this block_id when you receive an interaction payload to identify the source of the action 🔗.

If not specified, a block_id will be generated.

Maximum length for this field is 255 characters.

pub fn dispatch_actions(self, should: bool) -> Self

Set dispatch_action (Optional)

Will allow the elements in this block to dispatch block_actions payloads.

Defaults to false.

pub fn optional(self, optional: bool) -> Self

Sets optional (Required)

A boolean that indicates whether the input element may be empty when a user submits the modal.

Defaults to false.

pub fn hint<T>(self, hint: T) -> Self where
    T: Into<Plain>, 

Set hint (Optional)

An optional hint that appears below an input element in a lighter grey.

Maximum length for the text in this field is 2000 characters.

impl<'a, L> InputBuilder<'a, RequiredMethodNotCalled<element>, L>

pub fn element<El>(self, element: El) -> InputBuilder<'a, Set<element>, L> where
    El: Into<SupportedElement<'a>>, 

Set element (Required)

An interactive block_element that will be used to gather the input for this block.

For the kinds of Elements supported by Input blocks, see the SupportedElement enum.

pub fn child<El>(self, element: El) -> InputBuilder<'a, Set<element>, L> where
    El: Into<SupportedElement<'a>>, 

This is supported on crate feature xml only.

XML child alias for element

impl<'a> InputBuilder<'a, Set<element>, Set<label>>

pub fn build(self) -> Input<'a>

All done building, now give me a darn actions block!

no method name 'build' found for struct 'InputBuilder<...>'? Make sure all required setter methods have been called. See docs for InputBuilder.

use slack_blocks::blocks::Input;

let foo = Input::builder().build(); // Won't compile!

use slack_blocks::{blocks::Input,
                   compose::text::ToSlackPlaintext,
                   elems::TextInput};

let block =
  Input::builder().label("foo".plaintext())
                  .element(TextInput::builder().action_id("foo").build())
                  .build();

Trait Implementations

impl<'a, Element: Debug, Label: Debug> Debug for InputBuilder<'a, Element, Label>

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

Formats the value using the given formatter.