Struct slack_blocks::compose::text::mrkdwn::Contents

pub struct Contents { /* fields omitted */ }

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

Implementations

impl Contents

pub fn from_text(text: impl ToString) -> Self

Construct some markdown text from a string or string-like value

Arguments

• text - The text contents to render for this Text object. For some basic formatting examples, see the docs above for the Contents struct itself, 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.

Example

use slack_blocks::compose::text::{mrkdwn, Text};

let text = mrkdwn::Contents::from_text("This link doesn't work! :tada: https://www.cheese.com")
    .with_verbatim(true);

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

Sets the verbatim flag

Arguments

• verbatim - 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.

Example

use slack_blocks::compose::text::{mrkdwn, Text};

let text = mrkdwn::Contents::from_text("This link doesn't work! :tada: https://www.cheese.com")
    .with_verbatim(true);

Trait Implementations

impl AsRef<str> for Contents

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Contents

fn clone(&self) -> Contents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contents

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

Formats the value using the given formatter.

impl Default for Contents

fn default() -> Contents

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Contents

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

Deserialize this value from the given Serde deserializer.

impl<'_> From<&'_ str> for Contents

fn from(text: &str) -> Self

Performs the conversion.

impl From<Contents> for Compose

fn from(text: Mrkdwn) -> Self

Performs the conversion.

impl From<Contents> for Text

fn from(src: Contents) -> Self

Performs the conversion.

impl From<String> for Contents

fn from(text: String) -> Self

Performs the conversion.

impl Hash for Contents

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<Contents> for Contents

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

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

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

This method tests for !=.

impl Serialize for Contents

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 Contents