Struct slack_blocks::compose::opt::build::OptBuilder

pub struct OptBuilder<'a, Text, Value, Url> { /* fields omitted */ }

Option builder

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

Required Methods

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

• text or text_plain or text_md
• value

Example

use std::convert::TryFrom;

use slack_blocks::{blocks::{Actions, Block},
                   compose::Opt,
                   elems::{select::Static, BlockElement}};
let langs = vec![("Rust", "rs"), ("Haskell", "hs"), ("NodeJS", "node")];

let langs =
  langs.into_iter().map(|(name, code)| {
                     Opt::builder().text_plain(name).value(code).build()
                   });

let select =
  Static::builder().placeholder("Choose your favorite programming language!")
                   .options(langs)
                   .action_id("lang_chosen")
                   .build();

let block: Block = Actions::builder().element(select).build().into();

// <send block to API>

Implementations

impl<T, V, U> OptBuilder<'static, T, V, U>

pub fn new() -> OptBuilderInit<'static>

Construct a new OptBuilder

impl<'a, T, V, U> OptBuilder<'a, T, V, U>

pub fn value<S>(self, value: S) -> OptBuilder<'a, T, Set<value>, U> where
    S: Into<Cow<'a, str>>, 

Set value (Required)

The string value that will be passed to your app when this option is chosen.

Maximum length for this field is 75 characters.

pub fn desc<S>(self, desc: S) -> OptBuilder<'a, T, V, U> where
    S: Into<Plain>, 

Set description (Optional)

A plain_text only text object 🔗 that defines a line of descriptive text shown below the text field beside the radio button.

Maximum length for the text object within this field is 75 characters.

impl<'a, V, U> OptBuilder<'a, RequiredMethodNotCalled<text>, V, U>

pub fn child<T: Into<Text>>(
    self,
    text: T
) -> OptBuilder<'a, Set<(text, T)>, V, U>

This is supported on crate feature blox only.

Alias for text, allowing you to set the text of the option like so:

use slack_blocks::{blox::*, compose::Opt, text};

let xml = blox! {
  <option value="foo">
    <text kind=plain>"Foo"</text>
  </option>
};

let equiv = Opt::builder().value("foo")
                          .text(text::Plain::from("Foo"))
                          .build();

assert_eq!(xml, equiv)

pub fn text<Txt>(self, text: Txt) -> OptBuilder<'a, Set<(text, Txt)>, V, U> where
    Txt: Into<Text>, 

Set text (Required)

A text object 🔗 that defines the text shown in the option on the menu. Overflow, select, and multi-select menus can only use plain_text objects, while radio buttons and checkboxes can use mrkdwn text objects.

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

pub fn text_plain<Txt>(
    self,
    text: Txt
) -> OptBuilder<'a, Set<(text, Plain)>, V, U> where
    Txt: Into<Plain>, 

Set text (Required)

A text object 🔗 that defines the text shown in the option on the menu. Overflow, select, and multi-select menus can only use plain_text objects, while radio buttons and checkboxes can use mrkdwn text objects.

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

pub fn text_md<Txt>(
    self,
    text: Txt
) -> OptBuilder<'a, Set<(text, Mrkdwn)>, V, U> where
    Txt: Into<Mrkdwn>, 

Set text (Required)

A text object 🔗 that defines the text shown in the option on the menu. Overflow, select, and multi-select menus can only use plain_text objects, while radio buttons and checkboxes can use mrkdwn text objects.

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

impl<'a, V, U> OptBuilder<'a, Set<(text, Plain)>, V, U>

pub fn url<S>(self, url: S) -> OptBuilder<'a, Set<(text, Plain)>, V, Set<url>> where
    S: Into<Cow<'a, str>>, 

Set url (Optional)

The URL will be loaded in the user’s browser when the option is clicked.

Maximum length for this field is 3000 characters.

The url attribute is only available in overflow menus 🔗

If you’re using url, you’ll still receive an interaction payload 🔗 and will need to send an acknowledgement response 🔗.

pub fn no_url(self) -> OptBuilder<'a, Set<(text, Plain)>, V, Set<url>>

Flag opt as being usable in an AllowUrl context without setting Url explicitly.

impl<'a> OptBuilder<'a, Set<(text, Plain)>, Set<value>, Set<url>>

pub fn build(self) -> Opt<'a, Plain, AllowUrl>

All done building, now give me a darn option!

no method name 'build' found for struct 'compose::opt::build::OptBuilder<...>'?

Make sure all required setter methods have been called. See docs for OptBuilder.

use slack_blocks::compose::Opt;

let sel = Opt::builder().build(); // Won't compile!

use slack_blocks::compose::Opt;

let opt = Opt::builder().text_plain("cheese")
                        .value("cheese")
                        .url("https://cheese.com")
                        .build();

impl<'a, T: Into<Text>> OptBuilder<'a, Set<(text, T)>, Set<value>, OptionalMethodNotCalled<url>>

pub fn build(self) -> Opt<'a, T, NoUrl>

All done building, now give me a darn option!

no method name 'build' found for struct 'compose::opt::build::OptBuilder<...>'?

Make sure all required setter methods have been called. See docs for OptBuilder.

use slack_blocks::compose::Opt;

let sel = Opt::builder().text_plain("foo")
                        .build();
/*                       ^^^^^ method not found in
                         `OptBuilder<'_, Set<(text, text::Plain)>, RequiredMethodNotCalled<value>>`
*/

use slack_blocks::compose::Opt;

let opt = Opt::builder().text_md("cheese").value("cheese").build();

Trait Implementations

impl<'a, Text: Debug, Value: Debug, Url: Debug> Debug for OptBuilder<'a, Text, Value, Url>

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

Formats the value using the given formatter.