Struct slack_blocks::text::Mrkdwn [−][src]
pub struct Mrkdwn { /* fields omitted */ }
Expand description
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 |
---|---|
& | & |
< | < |
> | > |
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~ | |
\n | line break |
> a block quote | a block quote |
`some code!` | some code! |
```multiline code\n2 lines!``` | multiline code |
- li \n - 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
[src]
impl Contents
[src]pub fn from_text(text: impl ToString) -> Self
[src]
pub fn from_text(text: impl ToString) -> Self
[src]Construct some markdown text from a string or string-like value
Arguments
text
- The text contents to render for thisText
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
[src]
pub fn with_verbatim(self, verbatim: bool) -> Self
[src]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<'de> Deserialize<'de> for Contents
[src]
impl<'de> Deserialize<'de> for Contents
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl From<Contents> for ImageOrText<'static>
[src]
impl From<Contents> for ImageOrText<'static>
[src]impl TextKind<Contents> for mrkdwn
[src]
impl TextKind<Contents> for mrkdwn
[src]blox
only.fn set_kind<M>(self, builder: TextBuilder<Text, M>) -> TextBuilder<Mrkdwn, M>
[src]
fn set_kind<M>(self, builder: TextBuilder<Text, M>) -> TextBuilder<Mrkdwn, M>
[src]Invoke TextBuilder.mrkdwn
or TextBuilder.plain
impl StructuralPartialEq for Contents
[src]
Auto Trait Implementations
impl RefUnwindSafe for Contents
impl Send for Contents
impl Sync for Contents
impl Unpin for Contents
impl UnwindSafe for Contents
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToSlackMarkdown for T where
T: Into<Contents>,
[src]
impl<T> ToSlackMarkdown for T where
T: Into<Contents>,
[src]impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,