Struct Paint

pub struct Paint<T> {
    pub item: T,
    pub style: Style,
}

A structure encapsulating an item and styling.

Fields

item: T

style: Style

Implementations

impl Paint<&str>

pub fn content(&self) -> &str

Return plain content.

impl Paint<String>

pub fn content(&self) -> &str

Return plain content.

impl<T> Paint<T>

pub const fn new(item: T) -> Paint<T>

Constructs a new Paint structure encapsulating item with no set styling.

pub const fn wrapping(item: T) -> Paint<T>

Constructs a new wrapping Paint structure encapsulating item with default styling.

A wrapping Paint converts all color resets written out by the internal value to the styling of itself. This allows for seamless color wrapping of other colored text.

Performance

In order to wrap an internal value, the internal value must first be written out to a local buffer and examined. As a result, displaying a wrapped value is likely to result in a heap allocation and copy.

pub const fn rgb(r: u8, g: u8, b: u8, item: T) -> Paint<T>

Constructs a new Paint structure encapsulating item with the foreground color set to the RGB color r, g, b.

pub const fn fixed(color: u8, item: T) -> Paint<T>

Constructs a new Paint structure encapsulating item with the foreground color set to the fixed 8-bit color color.

pub const fn red(item: T) -> Paint<T>

pub const fn black(item: T) -> Paint<T>

pub const fn yellow(item: T) -> Paint<T>

pub const fn green(item: T) -> Paint<T>

pub const fn cyan(item: T) -> Paint<T>

pub const fn blue(item: T) -> Paint<T>

pub const fn magenta(item: T) -> Paint<T>

pub const fn white(item: T) -> Paint<T>

pub const fn style(&self) -> Style

Retrieves the style currently set on self.

pub const fn inner(&self) -> &T

Retrieves a borrow to the inner item.

pub fn with_style(self, style: Style) -> Paint<T>

Sets the style of self to style.

pub const fn wrap(self) -> Paint<T>

Makes self a wrapping Paint.

A wrapping Paint converts all color resets written out by the internal value to the styling of itself. This allows for seamless color wrapping of other colored text.

Performance

In order to wrap an internal value, the internal value must first be written out to a local buffer and examined. As a result, displaying a wrapped value is likely to result in a heap allocation and copy.

pub const fn fg(self, color: Color) -> Paint<T>

Sets the foreground to color.

pub const fn bg(self, color: Color) -> Paint<T>

Sets the background to color.

pub fn bold(self) -> Paint<T>

pub fn dim(self) -> Paint<T>

pub fn italic(self) -> Paint<T>

pub fn underline(self) -> Paint<T>

pub fn invert(self) -> Paint<T>

pub fn strikethrough(self) -> Paint<T>

pub fn blink(self) -> Paint<T>

pub fn hidden(self) -> Paint<T>

impl Paint<()>

pub fn is_enabled() -> bool

Returns true if coloring is enabled and false otherwise.

pub fn truecolor() -> bool

Check 24-bit RGB color support.

pub fn enable()

Enable paint styling.

pub fn set_terminal(tf: TerminalFile)

Set the terminal we are writing to. This influences the logic that checks whether or not to include colors.

pub fn force(force: bool)

Force paint styling. Useful when you want to output colors to a non-TTY.

pub fn disable()

Disable paint styling.

Trait Implementations

impl Cell for Paint<&str>

type Truncated = Paint<String>

Type after truncation.

type Padded = Paint<String>

Type after padding.

fn width(&self) -> usize

Cell display width in number of terminal columns.

fn background(&self) -> Color

Background color of cell.

fn truncate(&self, width: usize, delim: &str) -> Paint<String>

Truncate cell if longer than given width. Shows the delimiter if truncated.

fn pad(&self, width: usize) -> Paint<String>

Pad the cell so that it is the given width, while keeping the content left-aligned.

impl Cell for Paint<String>

type Truncated = Paint<String>

Type after truncation.

type Padded = Paint<String>

Type after padding.

fn width(&self) -> usize

Cell display width in number of terminal columns.

fn background(&self) -> Color

Background color of cell.

fn truncate(&self, width: usize, delim: &str) -> Paint<String>

Truncate cell if longer than given width. Shows the delimiter if truncated.

fn pad(&self, width: usize) -> Paint<String>

Pad the cell so that it is the given width, while keeping the content left-aligned.

impl<T> Clone for Paint<T>

where T: Clone,

fn clone(&self) -> Paint<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Paint<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Paint<T>

where T: Default,

fn default() -> Paint<T>

Returns the “default value” for a type.

impl<T> Display for Paint<T>

where T: Display,

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

Formats the value using the given formatter.

impl From<&str> for Paint<String>

fn from(item: &str) -> Paint<String>

Converts to this type from the input type.

impl From<Paint<&str>> for Paint<String>

fn from(paint: Paint<&str>) -> Paint<String>

Converts to this type from the input type.

impl<D> From<Paint<D>> for Label

where D: Display,

fn from(paint: Paint<D>) -> Label

Converts to this type from the input type.

impl<T> From<T> for Paint<T>

fn from(value: T) -> Paint<T>

Converts to this type from the input type.

impl<T> Hash for Paint<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Paint<T>

where T: Ord,

fn cmp(&self, other: &Paint<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Paint<T>

where T: PartialEq,

fn eq(&self, other: &Paint<T>) -> 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<T> PartialOrd for Paint<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Paint<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for Paint<T>

where T: Copy,

impl<T> Eq for Paint<T>

where T: Eq,

impl<T> StructuralPartialEq for Paint<T>