Skip to main content

RenderPluginsBuilder

Struct RenderPluginsBuilder 

Source
pub struct RenderPluginsBuilder<'p, S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<'p, S: State> RenderPluginsBuilder<'p, S>

Source

pub fn build(self) -> RenderPlugins<'p>
where S: IsComplete,

Finish building and return the requested object

Source

pub fn codefence_syntax_highlighter( self, value: &'p dyn SyntaxHighlighterAdapter, ) -> RenderPluginsBuilder<'p, SetCodefenceSyntaxHighlighter<S>>
where S::CodefenceSyntaxHighlighter: IsUnset,

Optional (Some / Option setters).

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");
Source

pub fn maybe_codefence_syntax_highlighter( self, value: Option<&'p dyn SyntaxHighlighterAdapter>, ) -> RenderPluginsBuilder<'p, SetCodefenceSyntaxHighlighter<S>>
where S::CodefenceSyntaxHighlighter: IsUnset,

Optional (Some / Option setters).

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");
Source

pub fn heading_adapter( self, value: &'p dyn HeadingAdapter, ) -> RenderPluginsBuilder<'p, SetHeadingAdapter<S>>
where S::HeadingAdapter: IsUnset,

Optional (Some / Option setters).

Optional heading adapter

Source

pub fn maybe_heading_adapter( self, value: Option<&'p dyn HeadingAdapter>, ) -> RenderPluginsBuilder<'p, SetHeadingAdapter<S>>
where S::HeadingAdapter: IsUnset,

Optional (Some / Option setters).

Optional heading adapter

Auto Trait Implementations§

§

impl<'p, S> Freeze for RenderPluginsBuilder<'p, S>

§

impl<'p, S = Empty> !RefUnwindSafe for RenderPluginsBuilder<'p, S>

§

impl<'p, S> Send for RenderPluginsBuilder<'p, S>

§

impl<'p, S> Sync for RenderPluginsBuilder<'p, S>

§

impl<'p, S> Unpin for RenderPluginsBuilder<'p, S>

§

impl<'p, S> UnsafeUnpin for RenderPluginsBuilder<'p, S>

§

impl<'p, S = Empty> !UnwindSafe for RenderPluginsBuilder<'p, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.