Struct Options 

pub struct Options {
    pub stringify: StringifyOptions,
    pub newlines: bool,
    pub checked: Option<String>,
    pub unchecked: Option<String>,
    pub quotes: Vec<String>,
}

Conversion options.

Fields

stringify: StringifyOptions

Serializer formatting options.

newlines: bool

Whether to preserve newlines in whitespace normalization.

checked: Option<String>

Symbol for checked checkboxes/radio buttons. Default: "[x]".

unchecked: Option<String>

Symbol for unchecked checkboxes/radio buttons. Default: "[ ]".

quotes: Vec<String>

Quote character pairs for <q> elements, cycling by nesting depth. Each entry is 1 or 2 chars: open (and optionally close). Default: ['"'] (plain ASCII double-quote for both open and close).

Implementations

impl Options

pub fn new() -> Self

Create a new Options with default settings.

pub fn with_heading_style(self, style: HeadingStyle) -> Self

Set the heading style.

pub fn with_bullet(self, bullet: char) -> Self

Set the unordered list bullet character.

Panics

Panics if bullet is not one of *, -, or +.

pub fn with_bullet_ordered(self, bullet: char) -> Self

Set the ordered list bullet character (. or )).

Panics

Panics if bullet is not . or ).

pub fn with_emphasis(self, marker: char) -> Self

Set the emphasis marker character (* or _).

Panics

Panics if marker is not * or _.

pub fn with_strong(self, marker: char) -> Self

Set the strong marker character (* or _).

Panics

Panics if marker is not * or _.

pub fn with_fence(self, fence: char) -> Self

Set the fenced code block marker character (` or ~).

Panics

Panics if fence is not ` or ~.

pub fn with_rule(self, rule: char) -> Self

Set the thematic break rule character (*, -, or _).

Panics

Panics if rule is not *, -, or _.

pub fn with_rule_repetition(self, count: u8) -> Self

Set the number of thematic break markers (minimum 3).

Panics

Panics if count is less than 3.

pub fn with_rule_spaces(self, spaces: bool) -> Self

Set whether to use spaces in thematic breaks.

pub fn with_close_atx(self, close: bool) -> Self

Set whether to close ATX headings with trailing hashes.

pub fn with_list_item_indent(self, indent: ListItemIndent) -> Self

Set the list item indentation style.

pub fn with_increment_list_marker(self, increment: bool) -> Self

Set whether to increment ordered list markers.

pub fn with_quote(self, quote: char) -> Self

Set the quote character for titles (" or ').

Panics

Panics if quote is not " or '.

pub fn with_fences(self, fences: bool) -> Self

Set whether to always use fenced code blocks.

pub fn with_resource_link(self, resource: bool) -> Self

Set whether to always use resource links (never autolinks).

pub fn with_newlines(self, newlines: bool) -> Self

Set whether to preserve newlines in whitespace normalization.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.