Struct comrak::RenderPluginsBuilder

pub struct RenderPluginsBuilder<'p> { /* private fields */ }

Builder for RenderPlugins.

Implementations

impl<'p> RenderPluginsBuilder<'p>

pub fn codefence_syntax_highlighter( &mut self, value: Option<&'p dyn SyntaxHighlighterAdapter> ) -> &mut Self

Provide a syntax highlighter adapter implementation for syntax highlighting of codefence blocks.

use std::collections::HashMap;
use std::io::{self, Write};
let options = Options::default();
let mut plugins = Plugins::default();
let input = "```rust\nfn main<'a>();\n```";

assert_eq!(markdown_to_html_with_plugins(input, &options, &plugins),
           "<pre><code class=\"language-rust\">fn main&lt;'a&gt;();\n</code></pre>\n");

pub struct MockAdapter {}
impl SyntaxHighlighterAdapter for MockAdapter {
    fn write_highlighted(&self, output: &mut dyn Write, lang: Option<&str>, code: &str) -> io::Result<()> {
        write!(output, "<span class=\"lang-{}\">{}</span>", lang.unwrap(), code)
    }

    fn write_pre_tag(&self, output: &mut dyn Write, _attributes: HashMap<String, String>) -> io::Result<()> {
        output.write_all(b"<pre lang=\"rust\">")
    }

    fn write_code_tag(&self, output: &mut dyn Write, _attributes: HashMap<String, String>) -> io::Result<()> {
        output.write_all(b"<code class=\"language-rust\">")
    }
}

let adapter = MockAdapter {};
plugins.render.codefence_syntax_highlighter = Some(&adapter);

assert_eq!(markdown_to_html_with_plugins(input, &options, &plugins),
           "<pre lang=\"rust\"><code class=\"language-rust\"><span class=\"lang-rust\">fn main<'a>();\n</span></code></pre>\n");

pub fn heading_adapter( &mut self, value: Option<&'p dyn HeadingAdapter> ) -> &mut Self

Optional heading adapter

pub fn build(&self) -> Result<RenderPlugins<'p>, RenderPluginsBuilderError>

Builds a new RenderPlugins.

Errors

If a required field has not been initialized.

Trait Implementations

impl<'p> Clone for RenderPluginsBuilder<'p>

fn clone(&self) -> RenderPluginsBuilder<'p>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'p> Default for RenderPluginsBuilder<'p>

fn default() -> Self

Returns the “default value” for a type.