Struct TerminalStyle 

pub struct TerminalStyle { /* private fields */ }

Stores a custom style for terminal text. This creates the escape command needed to change terminal text color. ANSI Escape Codes

Examples

use terminal_text_styler::{TerminalStyle, SGREffect, ANSIForegroundColor};

// Manual with codes
let yellow_manual = TerminalStyle::from(vec![0, 93]);

// Using enums
let yellow = TerminalStyle::new(vec![SGREffect::Normal], Some(ANSIForegroundColor::BrightYellow), None);
let no_color = TerminalStyle::new_empty();
assert_eq!(yellow.command(), "\u{001B}[0;93m");
assert_eq!(no_color.command(), "\u{001B}[0m");
assert_eq!(yellow.wrap("Hello, World!"), "\u{001B}[0;93mHello, World!\u{001B}[0m");

Implementations

impl TerminalStyle

pub fn codes(&self) -> &Vec<u8>

List of raw ANSI SGR escape codes used to build the style

pub fn command(&self) -> &str

The built command string with escape code

pub fn styles(&self) -> Vec<SGREffect>

Gets a list of all applied SGR effect styles

pub fn foreground(&self) -> Option<ANSIForegroundColor>

Looks up the foreground color (Note: This is not supported for ANSI 256-colors and will return None)

pub fn background(&self) -> Option<ANSIBackgroundColor>

Looks up the background color (Note: This is not supported for ANSI 256-colors and will return None)

pub fn from(codes: Vec<u8>) -> Self

Creates a new terminal color with given escape codes.

pub fn new_empty() -> Self

Creates a new empty terminal color (aka no color).

pub fn new( effects: Vec<SGREffect>, foreground: Option<ANSIForegroundColor>, background: Option<ANSIBackgroundColor>, ) -> Self

Creates a new terminal color with given options.

pub fn wrap(&self, text: &str) -> String

Wraps given text with a command to start the custom color at the beginning and ends the string with a no-color command.

Examples

use terminal_text_styler::{TerminalStyle, SGREffect, ANSIForegroundColor};

let style = TerminalStyle::new(vec![SGREffect::Bold], Some(ANSIForegroundColor::BrightYellow), None);
let output = style.wrap("This will be bold and highlighted in bright yellow.");
println!("{}", output);

impl TerminalStyle

pub fn no_color() -> Self

pub fn reset() -> Self

pub fn black() -> Self

pub fn red() -> Self

pub fn green() -> Self

pub fn yellow() -> Self

pub fn blue() -> Self

pub fn magenta() -> Self

pub fn cyan() -> Self

pub fn white() -> Self

pub fn bright_black() -> Self

pub fn bright_red() -> Self

pub fn bright_green() -> Self

pub fn bright_yellow() -> Self

pub fn bright_blue() -> Self

pub fn bright_magenta() -> Self

pub fn bright_cyan() -> Self

pub fn bright_white() -> Self

pub fn italic_black() -> Self

pub fn italic_red() -> Self

pub fn italic_green() -> Self

pub fn italic_yellow() -> Self

pub fn italic_blue() -> Self

pub fn italic_magenta() -> Self

pub fn italic_cyan() -> Self

pub fn italic_white() -> Self

pub fn red_background() -> Self

pub fn blue_background() -> Self

pub fn green_background() -> Self

pub fn yellow_background() -> Self

pub fn normal_bright_yellow() -> Self

pub fn blink() -> Self

Trait Implementations

impl Clone for TerminalStyle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalStyle

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

Formats the value using the given formatter.

impl Display for TerminalStyle

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

Formats the value using the given formatter.

impl PartialEq for TerminalStyle

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TerminalStyle