#[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: boolOmit markdown styling from the output
omit_spoiler: boolOmit spoilers from the output
omit_one_line_code: boolOmit inline codes from the output
omit_multi_line_code: boolOmit multiline code blocks from the output
Implementations§
Source§impl ToMarkdownStringOption
impl ToMarkdownStringOption
pub fn new() -> Self
pub fn omit_format(self, value: bool) -> Self
pub fn omit_spoiler(self, value: bool) -> Self
pub fn omit_one_line_code(self, value: bool) -> Self
pub fn omit_multi_line_code(self, value: bool) -> Self
Trait Implementations§
Source§impl Default for ToMarkdownStringOption
impl Default for ToMarkdownStringOption
Source§fn default() -> ToMarkdownStringOption
fn default() -> ToMarkdownStringOption
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for ToMarkdownStringOption
impl RefUnwindSafe for ToMarkdownStringOption
impl Send for ToMarkdownStringOption
impl Sync for ToMarkdownStringOption
impl Unpin for ToMarkdownStringOption
impl UnwindSafe for ToMarkdownStringOption
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more