ToMarkdownStringOption

Struct ToMarkdownStringOption 

Source
#[non_exhaustive]
pub struct ToMarkdownStringOption { pub omit_format: bool, pub omit_spoiler: bool, pub omit_one_line_code: bool, pub omit_multi_line_code: bool, }
Expand description

Struct that allows to alter to_markdown_string()’s behaviour.

§Example

use discord_md::ast::*;
use discord_md::generate::{ToMarkdownString, ToMarkdownStringOption};

let ast = MarkdownDocument::new(vec![
    MarkdownElement::Spoiler(Box::new(Spoiler::new("spoiler"))),
    MarkdownElement::Plain(Box::new(Plain::new(" text "))),
    MarkdownElement::OneLineCode(Box::new(OneLineCode::new("code"))),
]);

assert_eq!(ast.to_markdown_string(&ToMarkdownStringOption::new()), "||spoiler|| text `code`");
assert_eq!(ast.to_markdown_string(&ToMarkdownStringOption::new().omit_format(true)), "spoiler text code");
assert_eq!(ast.to_markdown_string(&ToMarkdownStringOption::new().omit_spoiler(true)), " text `code`");
assert_eq!(ast.to_markdown_string(&ToMarkdownStringOption::new().omit_format(true).omit_one_line_code(true)), "spoiler text ");

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§omit_format: bool

Omit markdown styling from the output

§omit_spoiler: bool

Omit spoilers from the output

§omit_one_line_code: bool

Omit inline codes from the output

§omit_multi_line_code: bool

Omit multiline code blocks from the output

Implementations§

Source§

impl ToMarkdownStringOption

Source

pub fn new() -> Self

Source

pub fn omit_format(self, value: bool) -> Self

Source

pub fn omit_spoiler(self, value: bool) -> Self

Source

pub fn omit_one_line_code(self, value: bool) -> Self

Source

pub fn omit_multi_line_code(self, value: bool) -> Self

Trait Implementations§

Source§

impl Default for ToMarkdownStringOption

Source§

fn default() -> ToMarkdownStringOption

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.