Struct ReaderOptions 

#[non_exhaustive]
pub struct ReaderOptions {
    pub extensions: Extensions,
    pub tab_stop: usize,
    pub greedy_paragraphs: bool,
    pub source_dir: Option<PathBuf>,
}

Options controlling a Reader.

Fields (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.

extensions: Extensions

Format extensions to enable. Strict-CommonMark readers ignore this (the empty preset).

tab_stop: usize

Column grid a tab advances to in the formats that expand tabs. Zero leaves tabs as written.

greedy_paragraphs: bool

When set, an open paragraph is greedy: a following line that would otherwise open a block (a blockquote, heading, list, thematic break, fenced div, or footnote definition) is folded into the paragraph as a lazy continuation instead. Only a blank line, a fenced code block, or an HTML block ends the paragraph. Unset, every such line interrupts the paragraph.

source_dir: Option<PathBuf>

The directory the input was named under, as written. A format whose sources refer to companion files (included sources, imported modules, image paths) resolves them against it; unset, such references are left exactly as written.

Trait Implementations

impl Clone for ReaderOptions

fn clone(&self) -> ReaderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReaderOptions

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

Formats the value using the given formatter.

impl Default for ReaderOptions

fn default() -> Self

Returns the “default value” for a type.