Struct Encoder 

pub struct Encoder { /* private fields */ }

Turns lines of styled spans into the bytes a terminal reads.

Layout never sees an escape byte: it produces Lines, and this encoder adds the styling afterwards.

• It writes a style sequence only where the style changes between spans, with every colour converted to the encoder’s depth.
• It skips a span with no text.
• It writes a reset where a style ends. At the end of a line it writes one only when a style is still open, so each line stands alone in head, less -R, and a log.

An encoder with no depth writes the text of each line byte for byte, with no escape.

It needs no terminal, because the depth is an argument. A program that renders to a string or to bytes builds one from a depth it chose.

use ctl_term::ctl_text::anstyle::AnsiColor;
use ctl_term::ctl_text::{Line, Span, Style};
use ctl_term::{ColorDepth, Encoder};

let red = Style::new().fg_color(Some(AnsiColor::Red.into()));
let lines = [Line::from(Span::new("failed", red))];

let text = Encoder::new(Some(ColorDepth::TrueColor)).encode(&lines);
assert_eq!(text, "\u{1b}[31mfailed\u{1b}[0m\n");
assert_eq!(text.into_bytes(), b"\x1b[31mfailed\x1b[0m\n");

Implementations

impl Encoder

pub const fn new(depth: Option<ColorDepth>) -> Self

An encoder that writes colour at depth, or none for None.

pub fn encode(self, lines: &[Line]) -> String

lines as text, each line ended by a newline.

Each line starts with no style on and ends with none on.

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Encoder

impl Debug for Encoder

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

Formats the value using the given formatter.

impl Eq for Encoder

impl PartialEq for Encoder

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Encoder