Struct comrak::ComrakRenderPlugins

pub struct ComrakRenderPlugins<'p> {
    pub codefence_syntax_highlighter: Option<&'p dyn SyntaxHighlighterAdapter>,
    pub heading_adapter: Option<&'p dyn HeadingAdapter>,
}

Plugins for alternative rendering.

Fields

codefence_syntax_highlighter: Option<&'p dyn SyntaxHighlighterAdapter>

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

use std::collections::HashMap;
use std::io::{self, Write};
let options = ComrakOptions::default();
let mut plugins = ComrakPlugins::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");

heading_adapter: Option<&'p dyn HeadingAdapter>

Optional heading adapter

Trait Implementations

impl Debug for ComrakRenderPlugins<'_>

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

Formats the value using the given formatter.

impl<'p> Default for ComrakRenderPlugins<'p>

fn default() -> ComrakRenderPlugins<'p>

Returns the “default value” for a type.