Struct slack_blocks::blocks::section::build::SectionBuilder

pub struct SectionBuilder<'a, Text> { /* fields omitted */ }

Build an Section block

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

Required Methods

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

• text or field(s), both may be called.

Example

use slack_blocks::{blocks::Section,
                   elems::Image,
                   text,
                   text::ToSlackPlaintext};

let block =
  Section::builder().text("foo".plaintext())
                    .field("bar".plaintext())
                    .field("baz".plaintext())
                    // alternatively:
                    .fields(vec!["bar".plaintext(),
                                 "baz".plaintext()]
                                 .into_iter()
                                 .map(text::Text::from)
                    )
                    .accessory(Image::builder().image_url("foo.png")
                                               .alt_text("pic of foo")
                                               .build())
                    .build();

Implementations

impl<'a, E> SectionBuilder<'a, E>

pub fn new() -> Self

Create a new SectionBuilder

pub fn accessory<B>(self, acc: B) -> Self where
    B: Into<BlockElement<'a>>, 

Set accessory (Optional)

pub fn text<T>(self, text: T) -> SectionBuilder<'a, Set<text>> where
    T: Into<Text>, 

Add text (Required: this or field(s))

The text for the block, in the form of a text object 🔗.

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

pub fn fields<I>(self, fields: I) -> SectionBuilder<'a, Set<text>> where
    I: IntoIterator<Item = Text>, 

Set fields (Required: this or text)

A collection of text objects 🔗.

Any text objects included with fields will be rendered in a compact format that allows for 2 columns of side-by-side text.

Maximum number of items is 10.

Maximum length for the text in each item is 2000 characters.

pub fn field<T>(self, text: T) -> SectionBuilder<'a, Set<text>> where
    T: Into<Text>, 

Append a single field to fields.

pub fn child<T>(self, text: T) -> SectionBuilder<'a, Set<text>> where
    T: Into<Text>, 

This is supported on crate feature xml only.

XML macro children, appends fields to the Section.

To set text, use the text attribute.

use mox::mox;
use slack_blocks::{blocks::Section, mox::*, text, text::ToSlackPlaintext};

let xml = mox! {
  <section_block text={"Section".plaintext()}>
    <text kind=plain>"Foo"</text>
    <text kind=plain>"Bar"</text>
  </section_block>
};

let equiv = Section::builder().text("Section".plaintext())
                              .field("Foo".plaintext())
                              .field("Bar".plaintext())
                              .build();

assert_eq!(xml, equiv);

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.

impl<'a> SectionBuilder<'a, Set<text>>

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

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

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

use slack_blocks::blocks::Section;

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

use slack_blocks::{blocks::Section,
                   compose::text::ToSlackPlaintext,
                   elems::Image};

let block =
  Section::builder().text("foo".plaintext())
                    .accessory(Image::builder().image_url("foo.png")
                                               .alt_text("pic of foo")
                                               .build())
                    .build();

Trait Implementations

impl<'a, Text: Debug> Debug for SectionBuilder<'a, Text>

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

Formats the value using the given formatter.