Enum slack_blocks::compose::Text

pub enum Text {
    Markdown {
        text: String,
        verbatim: Option<bool>,
    },
    Plain {
        text: String,
        emoji: Option<bool>,
    },
}

Text Object

slack api docs 🔗

An object containing some text, formatted either as plain_text or using mrkdwn 🔗, our proprietary textual markup that's just different enough from Markdown to frustrate you.

Variants

Markdown

Markdown text

for more info, check out the slack api docs 🔗

Reserved Characters

Slack uses the following special characters, and recommends you HTML escape them like so:

➤ Click to expand

character	how to escape
&	&
<	&lt;
>	&gt;

Basic Formatting

NOTE: This is not an exhaustive list

This should, however, capture most basic use cases without requiring that you check with the Slack documentation.

For more info, please visit Slack's docs for markdown formatting 🔗

➤ Click to expand

slack markdown	formatted result
_italic_	italic
*bold*	bold
~strike~	strike
\n	line break
> a block quote	a block quote
`some code!`	some code!
```multiline code\n2 lines!```	multiline code 2 lines!
- li \n - li	li li
<http://www.foo.com|link name>	link name
:joy: (list from iamcal/emoji-data 🔗)	😂
link to #channel: <#Cxxxxxx>	#channel
link to @user: <@Uxxxxxx>	@user
link to @user_group: <!subteam^xxxxxx>	@user_group

Fields of Markdown

text: String

The text for the block.

This field accepts any of the standard text formatting markup

verbatim: Option<bool>

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.

Plain

Fields of Plain

text: String

The text for the block

emoji: Option<bool>

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

Implementations

impl Text

pub fn plain<StrIsh: AsRef<str>>(text: StrIsh) -> Text

pub fn markdown<StrIsh: AsRef<str>>(text: StrIsh) -> Text

pub fn text(&self) -> &str

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Text

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Text> for Compose

fn from(contents: Text) -> Self

Performs the conversion.

impl Hash for Text

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Text> for Text

fn eq(&self, other: &Text) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Text) -> bool

This method tests for !=.

impl Serialize for Text

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 Text