Struct slack_blocks::text::build::TextBuilder

pub struct TextBuilder<T, TMarker> { /* fields omitted */ }

Text Builder

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

Required Methods

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

• text
• plain or mrkdwn

use slack_blocks::text::Text;

let foo = Text::builder().plain().text("foo").build();

Implementations

impl<T> TextBuilder<T, RequiredMethodNotCalled<text>>

pub fn new() -> Self

Construct a new text builder

pub fn text(self, t: impl AsRef<str>) -> TextBuilder<T, Set<text>>

Set text (Required)

The text contents to render for this Text object.

For some basic formatting examples, see the docs for the text::Mrkdwn, or Slack’s markdown docs 🔗.

There are no intrinsic length limits on this, those are usually requirements of the context the text will be used in.

pub fn child(self, t: impl AsRef<str>) -> TextBuilder<T, Set<text>>

This is supported on crate feature blox only.

Alias of text for XML macros, allowing text to be set as a string literal instead of an attribute.

use slack_blocks::blox::*;

let as_attr = blox! {
  <text kind=plain text="Foo" />
};

let as_child = blox! {
  <text kind=plain>"Foo"</text>
};

assert_eq!(as_attr, as_child);

impl<M> TextBuilder<Text, M>

pub fn kind<T, K>(self, kind: K) -> TextBuilder<T, M> where
    T: Into<Text>,
    K: TextKind<T>, 

This is supported on crate feature blox only.

Set the kind of the text you’re building (Required)

Intended to be used as an XML attribute with build::kind::mrkdwn or build::kind::plain

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

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

let builder = text::Plain::from("Foo");

assert_eq!(xml, builder)

pub fn plain(self) -> TextBuilder<Plain, M>

Set the text you’re building to be plain_text (Required)

pub fn mrkdwn(self) -> TextBuilder<Mrkdwn, M>

Set the text you’re building to be mrkdwn (Required)

impl<M> TextBuilder<Mrkdwn, M>

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

Set verbatim (Optional)

When set to false (as is default) URLs will be auto-converted into links, conversation names will be link-ified, and certain mentions will be automatically parsed.

Using a value of true will skip any preprocessing of this nature, although you can still include manual parsing strings.

impl<M> TextBuilder<Plain, M>

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

Set emoji (Optional)

Indicates whether emojis in a text field should be escaped into the colon emoji format

impl TextBuilder<Plain, Set<text>>

pub fn build(self) -> Plain

All done building, now give me a darn text object!

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

use slack_blocks::text::Text;

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

use slack_blocks::text::Text;

let foo = Text::builder().plain()
                         .emoji(true)
                         .text("foo :joy:")
                         .build();

impl TextBuilder<Mrkdwn, Set<text>>

pub fn build(self) -> Mrkdwn

All done building, now give me a darn text object!

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

use slack_blocks::text::Text;

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

use slack_blocks::text::Text;

let foo = Text::builder().mrkdwn()
                         .verbatim(true)
                         .text("foo :joy:")
                         .build();

Trait Implementations

impl<T: Debug, TMarker: Debug> Debug for TextBuilder<T, TMarker>

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

Formats the value using the given formatter.