Struct WriterOptions 

pub struct WriterOptions {
    pub strict: bool,
    pub hard_break_spaces: bool,
    pub indent_spaces: usize,
    pub list_marker: char,
    pub thematic_break_char: char,
    pub emphasis_char: char,
    pub strong_char: char,
    pub escape_special_chars: bool,
    pub trim_paragraph_trailing_hard_breaks: bool,
    pub html_writer_options: Option<HtmlWriterOptions>,
}

CommonMark formatting options

Fields

strict: bool

Whether to enable strict mode (strictly following CommonMark specification)

hard_break_spaces: bool

Hard break mode (true uses two spaces followed by a newline, false uses backslash followed by a newline)

indent_spaces: usize

Number of spaces to use for indentation levels

list_marker: char

Character to use for unordered list markers (-, +, or *)

thematic_break_char: char

Character to use for thematic breaks (-, *, or _)

emphasis_char: char

Character to use for emphasis (_, or *)

strong_char: char

Character to use for strong emphasis (_, or *)

escape_special_chars: bool

Whether to escape special characters in text content

trim_paragraph_trailing_hard_breaks: bool

Whether to trim trailing hard breaks from paragraphs

html_writer_options: Option<HtmlWriterOptions>

HTML writer options for rendering HtmlElement nodes If None, options will be automatically derived from CommonMark options

Implementations

impl WriterOptions

pub fn html_writer_options(self, options: Option<HtmlWriterOptions>) -> Self

Set custom HTML writer options for rendering HtmlElement nodes

Trait Implementations

impl Clone for WriterOptions

fn clone(&self) -> WriterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriterOptions

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

Formats the value using the given formatter.

impl Default for WriterOptions

fn default() -> Self

Returns the “default value” for a type.