Struct syntastica::renderer::HtmlRenderer

pub struct HtmlRenderer;

A Renderer implementor for HTML output. Use this type with the render function.

The resulting HTML is not wrapped in any parent tag and defines no font by itself. Each styled text region uses a span tag and defines its styling inline using the style attribute.

Example

use syntastica::{renderer::HtmlRenderer, theme};

// define a theme
let theme = theme! { "keyword": "#ff0000" }.resolve_links().unwrap();

// define highlights
let highlights = vec![vec![("<fn>", Some("keyword")), ("none", None)]];

// render to HTML
let output = syntastica::render(&highlights, &mut HtmlRenderer, theme);

assert_eq!(
    output,
    r#"<span style="color:rgb(255,0,0);">&lt;fn&gt;</span>none"#
);

Implementations

impl HtmlRenderer

pub fn new() -> Self

Create a new HtmlRenderer. Because HtmlRenderer is a unit struct, this is the same as just writing HtmlRenderer, but this function is provided for clarification nonetheless.

Trait Implementations

impl Default for HtmlRenderer

fn default() -> Self

Returns the “default value” for a type.

impl Renderer for HtmlRenderer

fn newline(&mut self) -> Cow<'static, str>

Is called at the end of every input line. The returned string will be used for line breaks in the output.

fn escape(&mut self, text: &str) -> Cow<'static, str>

Is called for every region of the input, both styled and unstyled.

fn styled(&mut self, text: &str, style: Style) -> Cow<'static, str>

Is called for every styled region of the input.

fn head(&mut self) -> Cow<'static, str>

Is called at the start of rendering, before anything else. The returned string will be the start of the final output.

fn tail(&mut self) -> Cow<'static, str>

Is called at the end of rendering, after the final call to Renderer::newline. The returned string will be the end of the final output.

fn unstyled<'a>(&mut self, text: &'a str) -> Cow<'a, str>

Is called for every unstyled region of the input.