Struct TerminalRenderer

pub struct TerminalRenderer { /* private fields */ }

A Renderer implementor for true-color ANSI terminal output. Use this type with the render function.

A background color can optionally be set which will behind the output until the exact end of each line.

Example

use syntastica::{renderer::TerminalRenderer, 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 a string without a background color
let output = syntastica::render(&highlights, &mut TerminalRenderer::new(None), theme);

assert_eq!(output, "\x1b[38;2;255;0;0mfn\x1b[0m none");

Implementations

impl TerminalRenderer

pub fn new(background_color: Option<Color>) -> Self

Create a new TerminalRenderer with an optional background color.

Trait Implementations

impl Default for TerminalRenderer

fn default() -> TerminalRenderer

Returns the “default value” for a type.

impl Renderer for TerminalRenderer

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

Is called for every unstyled region of the input.

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 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<'a>(&mut self, text: &'a str) -> Cow<'a, str>

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