Struct comrak::ParseOptionsBuilder

pub struct ParseOptionsBuilder { /* private fields */ }

Builder for ParseOptions.

Implementations

impl ParseOptionsBuilder

pub fn smart(&mut self, value: bool) -> &mut Self

Punctuation (quotes, full-stops and hyphens) are converted into ‘smart’ punctuation.

let mut options = Options::default();
assert_eq!(markdown_to_html("'Hello,' \"world\" ...", &options),
           "<p>'Hello,' &quot;world&quot; ...</p>\n");

options.parse.smart = true;
assert_eq!(markdown_to_html("'Hello,' \"world\" ...", &options),
           "<p>‘Hello,’ “world” …</p>\n");

pub fn default_info_string(&mut self, value: Option<String>) -> &mut Self

The default info string for fenced code blocks.

let mut options = Options::default();
assert_eq!(markdown_to_html("```\nfn hello();\n```\n", &options),
           "<pre><code>fn hello();\n</code></pre>\n");

options.parse.default_info_string = Some("rust".into());
assert_eq!(markdown_to_html("```\nfn hello();\n```\n", &options),
           "<pre><code class=\"language-rust\">fn hello();\n</code></pre>\n");

pub fn relaxed_tasklist_matching(&mut self, value: bool) -> &mut Self

Whether or not a simple x or X is used for tasklist or any other symbol is allowed.

pub fn relaxed_autolinks(&mut self, value: bool) -> &mut Self

Relax parsing of autolinks, allowing links to be detected inside brackets.

let mut options = Options::default();
options.extension.autolink = true;
assert_eq!(markdown_to_html("[https://foo.com]", &options),
           "<p>[https://foo.com]</p>\n");

options.parse.relaxed_autolinks = true;
assert_eq!(markdown_to_html("[https://foo.com]", &options),
           "<p>[<a href=\"https://foo.com\">https://foo.com</a>]</p>\n");

pub fn build(&self) -> Result<ParseOptions, ParseOptionsBuilderError>

Builds a new ParseOptions.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ParseOptionsBuilder

fn clone(&self) -> ParseOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ParseOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.