Struct easy_sgr::graphics::SGRString

pub struct SGRString {

    pub text: String,
    pub clean: CleanKind,
    pub custom_places: Vec<u8>,
    pub custom_cleans: Vec<u8>,
    pub foreground: ColorKind,
    pub background: ColorKind,
    pub reset: bool,
    pub bold: StyleKind,
    pub dim: StyleKind,
    pub italic: StyleKind,
    pub underline: StyleKind,
    pub blinking: StyleKind,
    pub inverse: StyleKind,
    pub hidden: StyleKind,
    pub strikethrough: StyleKind,
}

A String encapsulating the usage of SGR codes

SGR codes are applied when the Display trait is used, or when the SGRString::place_all or SGRString::clean_all functions are called.

Writing is done through the use of the writing module

Examples

use easy_sgr::{ColorKind, SGRString, StyleKind};

let mut string = SGRString::default();
string.text = String::from("This is my text");
string.bold = StyleKind::Place;
string.foreground = ColorKind::Red;
println!("{string}");

Fields

text: String

The actual text

clean: CleanKind

The type of clean to apply when SGRString::clean_all is called

By default CleanKind::None, meaning nothing is done

custom_places: Vec<u8>

Any custom codes added

These codes are written before the string when the Display trait is called

custom_cleans: Vec<u8>

Any custom codes added

These codes are written after the string when the Display trait is called

foreground: ColorKind

The color of the foreground

By default ColorKind::None, meaning nothing is applied. Not to be confused with ColorKind::Default, where the default SGR code for the foreground is applied.

background: ColorKind

The color of the background

By default ColorKind::None, meaning nothing is applied. Not to be confused with ColorKind::Default, where the default SGR code for the background is applied.

reset: bool

Determines whether the clear code 0 is to be applied to the beginning

Not be confused with [SGRString.clean], this effects SGRString::place_all

bold: StyleKind

Refer to StyleKind

dim: StyleKind

Refer to StyleKind

italic: StyleKind

Refer to StyleKind

underline: StyleKind

Refer to StyleKind

blinking: StyleKind

Refer to StyleKind

inverse: StyleKind

Refer to StyleKind

hidden: StyleKind

Refer to StyleKind

strikethrough: StyleKind

Refer to StyleKind

Implementations

impl SGRString

pub fn place_all(&self, builder: &mut SGRBuilder)

Writes all contained SGR codes to the given SGRBuilder

Does not perform any IO operations

pub fn place_colors(&self, builder: &mut SGRBuilder)

Writes contained SGR color codes to the given SGRWriter

Does not perform any IO operations

pub fn place_styles(&self, builder: &mut SGRBuilder)

Writes SGR style codes to the given SGRWriter

Does not perform any IO operations

pub fn place_custom(&self, builder: &mut SGRBuilder)

Writes custom SGR codes to the given SGRWriter

Does not perform any IO operations

pub fn clean_all(&self, builder: &mut SGRBuilder)

Writes contained SGR codes to the given SGRWriter

Reverses the effects of SGRString::place_all

Does not perform any IO operations

pub fn clean_colors(&self, builder: &mut SGRBuilder)

Writes SGR color codes to the given SGRWriter

Reverses the effects of SGRString::place_colors

Does not perform any IO operations

pub fn clean_styles(&self, builder: &mut SGRBuilder)

Writes SGR style codes to the given SGRWriter

Reverses the effects of SGRString::place_styles

Does not perform any IO operations

pub fn clean_custom(&self, builder: &mut SGRBuilder)

Writes SGR codes to the given SGRWriter

Reverses the effects of SGRString::place_custom

Does not perform any IO operations

Trait Implementations

impl Clone for SGRString

fn clone(&self) -> SGRString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SGRString

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

Formats the value using the given formatter.

impl Default for SGRString

fn default() -> SGRString

Returns the “default value” for a type.

impl Display for SGRString

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

Formats the value using the given formatter.

impl EasyWrite for SGRString

fn sgr(&self, builder: &mut SGRBuilder)

Writes a set of codes to the builder

Uses SGRString::place_all

impl From<&String> for SGRString

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for SGRString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Color> for SGRString

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<String> for SGRString

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Style> for SGRString

fn from(value: Style) -> Self

Converts to this type from the input type.