Struct cansi::CategorisedSlice

pub struct CategorisedSlice<'text> {
    pub text_as_bytes: &'text [u8],
    pub fg_colour: Color,
    pub bg_colour: Color,
    pub intensity: Intensity,
    pub italic: bool,
    pub underline: bool,
    pub blink: bool,
    pub reversed: bool,
    pub hidden: bool,
    pub strikethrough: bool,
}

Data structure that holds information about colouring and styling of a text slice.

Fields

text_as_bytes: &'text [u8]

The text slice as a byte array.

Note

Once the crate parse-ansi moves to regex crate 1.1.0 it will be possible to return a string slice (&str).

fg_colour: Color

The foreground (or text) colour.

bg_colour: Color

The background colour.

intensity: Intensity

The emphasis state (bold, faint, normal).

italic: bool

Italicised.

underline: bool

Underlined.

blink: bool

Slow blink text.

reversed: bool

Inverted colours. See https://en.wikipedia.org/wiki/Reverse_video.

hidden: bool

Invisible text.

strikethrough: bool

Struck-through.

Trait Implementations

impl<'text> PartialEq<CategorisedSlice<'text>> for CategorisedSlice<'text>

fn eq(&self, other: &CategorisedSlice<'text>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CategorisedSlice<'text>) -> bool

This method tests for !=.

impl<'text> Clone for CategorisedSlice<'text>

fn clone(&self) -> CategorisedSlice<'text>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'text> Debug for CategorisedSlice<'text>

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

Formats the value using the given formatter.