Struct mdcat::AnsiTerminal

pub struct AnsiTerminal<W: Write> { /* fields omitted */ }

A simple ANSI terminal with support for basic ANSI styles.

This represents most ordinary terminal emulators.

Methods

impl<W: Write> AnsiTerminal<W>

pub fn new(writer: W) -> AnsiTerminal<W>

Create a new ANSI terminal for th given writer.

pub fn write_osc(&mut self, command: &str) -> Result<()>

Write an OSC command to this terminal.

pub fn write_sgr(&mut self, command: &str) -> Result<()>

Write a CSI SGR command to this terminal.

See https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences.

pub fn write_style(&mut self, style: AnsiStyle) -> Result<()>

Write an ANSI style to this terminal.

Trait Implementations

impl<W: Write> Terminal for AnsiTerminal<W>

type TerminalWrite = W

The associated writer of this terminal.

fn name(&self) -> &'static str

Get a descriptive name for this terminal.

fn write(&mut self) -> &mut W

Get a writer for this terminal.

fn supports_styles(&self) -> bool

Whether this terminal supports styles.

fn set_style(&mut self, style: AnsiStyle) -> Result<(), Error>

Active a style on the terminal.

fn set_link(&mut self, _destination: &str) -> Result<(), Error>

Set a link to the given destination on the terminal.

fn set_mark(&mut self) -> Result<(), Error>

Set a jump mark on the terminal.

fn write_inline_image(     &mut self,     _max_size: Size,     _resources: &Resource,     _access: ResourceAccess ) -> Result<(), Error>

Write an inline image from the given resource to the terminal.