Struct MarkdownParserConfig 

pub struct MarkdownParserConfig { /* private fields */ }

A configuration for the Markdown parser.

Implementations

impl MarkdownParserConfig

pub fn with_allow_no_space_in_headings(self) -> Self

Enable the parser to allow headings without a space after the hash marks.

pub fn with_max_nesting_depth(self, depth: usize) -> Self

Set the maximum nesting depth of the document.

Every container block (blockquote, list item, footnote definition, GitHub alert) and every inline element with nested content (emphasis, strikethrough, link label) adds one level of nesting. When the depth exceeds depth, parse_markdown returns an error with nom::error::ErrorKind::TooLarge.

The limit bounds both the parse time and the stack usage on adversarial input (e.g. thousands of > markers). Defaults to DEFAULT_MAX_NESTING_DEPTH.

pub fn with_html_entities_map( self, html_entities_map: HashMap<String, &'static Entity>, ) -> Self

Set a custom map of HTML entities.

pub fn with_block_blockquote_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering blockquotes.

pub fn with_block_github_alert_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering GitHub alerts.

pub fn with_block_heading_v1_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering headings in style 1 (e.g., # Heading).

pub fn with_block_heading_v2_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering headings in style 2 (e.g., Heading\n===).

pub fn with_block_thematic_break_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering thematic breaks (e.g., ---).

pub fn with_block_list_behavior(self, behavior: ElementBehavior<Block>) -> Self

Set the behavior of the parser when encountering lists.

pub fn with_block_code_block_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering code blocks.

pub fn with_block_html_block_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering HTML blocks.

pub fn with_block_footnote_definition_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering footnote definitions.

pub fn with_block_link_definition_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering link definitions.

pub fn with_block_table_behavior(self, behavior: ElementBehavior<Block>) -> Self

Set the behavior of the parser when encountering tables.

pub fn with_block_paragraph_behavior( self, behavior: ElementBehavior<Block>, ) -> Self

Set the behavior of the parser when encountering block paragraphs.

pub fn with_inline_autolink_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline autolinks.

pub fn with_inline_link_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline links.

pub fn with_inline_footnote_reference_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline footnote references.

pub fn with_inline_reference_link_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline reference links.

pub fn with_inline_hard_newline_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline hard newlines.

pub fn with_inline_image_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline images.

pub fn with_inline_code_span_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline code spans.

pub fn with_inline_emphasis_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline emphasis.

pub fn with_inline_strikethrough_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline strikethrough.

pub fn with_inline_text_behavior( self, behavior: ElementBehavior<Inline>, ) -> Self

Set the behavior of the parser when encountering inline text.

pub fn with_custom_block_parser( self, parser: Rc<RefCell<Box<dyn for<'a> FnMut(&'a str) -> IResult<&'a str, Vec<Block>>>>>, ) -> Self

Set a custom parser for blocks.

pub fn with_custom_inline_parser( self, parser: Rc<RefCell<Box<dyn for<'a> FnMut(&'a str) -> IResult<&'a str, Vec<Inline>>>>>, ) -> Self

Set a custom parser for inlines.

Trait Implementations

impl Clone for MarkdownParserConfig

fn clone(&self) -> MarkdownParserConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MarkdownParserConfig

fn default() -> Self

Returns the “default value” for a type.