Struct Chalk

pub struct Chalk { /* private fields */ }

Implementations

impl Chalk

For all Chalks with different color types

pub fn new() -> Chalk

Creates a Chalk with a black background and a white foreground

Example

use chalk_rs::Chalk;

let mut chalk = Chalk::new();
// the chalk can be used here

pub fn string(&self, string: &dyn ToString) -> String

Formats a string using the style of the given Chalk.

This will return the string after being formatted to the console. When using string literals, please use a reference.

For example:

chalk.yellow().string(&"this is yellow");

Arguments

• string - The item to print out. It must implement ToString and should be a reference

Example

use chalk_rs::Chalk;

let mut chalk = Chalk::new();
let text = chalk.yellow().string(&"this is yellow");

pub fn print(&self, string: &dyn ToString) -> String

Prints a string using the style of the given chalk.

This will return the text that was outputted to the console. When using string literals, please use a reference.

For example:

chalk.yellow().print(&"this is yellow");

Arguments

• string - The item to format and output. It must implement ToString and should be a reference.

Example

use chalk_rs::Chalk;

let mut chalk = Chalk::new();
chalk.yellow().print(&"this is yellow");

pub fn println(&self, string: &dyn ToString) -> String

Prints a string using the style of the given chalk on a new line.

This will return the text that was outputted to the console. When using string literals, please use a reference.

For example:

chalk.yellow().println(&"this is yellow");

Arguments

• string - The item to format and output. It must implement ToString and should be a reference.

Example

use chalk_rs::Chalk;

let mut chalk = Chalk::new();
chalk.yellow().println(&"this is yellow");

impl Chalk

pub fn default_color(&mut self) -> &mut Chalk

pub fn black(&mut self) -> &mut Chalk

pub fn red(&mut self) -> &mut Chalk

pub fn green(&mut self) -> &mut Chalk

pub fn yellow(&mut self) -> &mut Chalk

pub fn blue(&mut self) -> &mut Chalk

pub fn magenta(&mut self) -> &mut Chalk

pub fn cyan(&mut self) -> &mut Chalk

pub fn light_gray(&mut self) -> &mut Chalk

pub fn light_grey(&mut self) -> &mut Chalk

pub fn gray(&mut self) -> &mut Chalk

pub fn grey(&mut self) -> &mut Chalk

pub fn light_black(&mut self) -> &mut Chalk

pub fn light_red(&mut self) -> &mut Chalk

pub fn light_green(&mut self) -> &mut Chalk

pub fn light_yellow(&mut self) -> &mut Chalk

pub fn light_blue(&mut self) -> &mut Chalk

pub fn light_magenta(&mut self) -> &mut Chalk

pub fn light_cyan(&mut self) -> &mut Chalk

pub fn white(&mut self) -> &mut Chalk

pub fn ansi(&mut self, color: u8) -> &mut Chalk

pub fn rgb(&mut self, r: u8, g: u8, b: u8) -> &mut Chalk

impl Chalk

pub fn default_background(&mut self) -> &mut Chalk

pub fn bg_black(&mut self) -> &mut Chalk

pub fn bg_red(&mut self) -> &mut Chalk

pub fn bg_green(&mut self) -> &mut Chalk

pub fn bg_yellow(&mut self) -> &mut Chalk

pub fn bg_blue(&mut self) -> &mut Chalk

pub fn bg_magenta(&mut self) -> &mut Chalk

pub fn bg_cyan(&mut self) -> &mut Chalk

pub fn bg_light_gray(&mut self) -> &mut Chalk

pub fn bg_light_grey(&mut self) -> &mut Chalk

pub fn bg_gray(&mut self) -> &mut Chalk

pub fn bg_grey(&mut self) -> &mut Chalk

pub fn bg_light_black(&mut self) -> &mut Chalk

pub fn bg_light_red(&mut self) -> &mut Chalk

pub fn bg_light_green(&mut self) -> &mut Chalk

pub fn bg_light_yellow(&mut self) -> &mut Chalk

pub fn bg_light_blue(&mut self) -> &mut Chalk

pub fn bg_light_magenta(&mut self) -> &mut Chalk

pub fn bg_light_cyan(&mut self) -> &mut Chalk

pub fn bg_white(&mut self) -> &mut Chalk

pub fn bg_ansi(&mut self, color: u8) -> &mut Chalk

pub fn bg_rgb(&mut self, r: u8, g: u8, b: u8) -> &mut Chalk

impl Chalk

pub fn reset_style(&mut self) -> &mut Chalk

pub fn reset_weight(&mut self) -> &mut Chalk

pub fn bold(&mut self) -> &mut Chalk

pub fn dim(&mut self) -> &mut Chalk

pub fn italic(&mut self) -> &mut Chalk

pub fn unitalic(&mut self) -> &mut Chalk

pub fn no_underline(&mut self) -> &mut Chalk

pub fn underline(&mut self) -> &mut Chalk

pub fn double_underline(&mut self) -> &mut Chalk

pub fn stop_blink(&mut self) -> &mut Chalk

pub fn blink(&mut self) -> &mut Chalk

pub fn invert(&mut self) -> &mut Chalk

pub fn uninvert(&mut self) -> &mut Chalk

pub fn hide(&mut self) -> &mut Chalk

pub fn unhide(&mut self) -> &mut Chalk

pub fn is_normal_weight(&self) -> bool

pub fn is_bold(&self) -> bool

pub fn is_dim(&self) -> bool

pub fn is_italicized(&self) -> bool

pub fn has_underlines(&self) -> bool

pub fn is_single_underlined(&self) -> bool

pub fn is_double_underlined(&self) -> bool

pub fn is_blinking(&self) -> bool

pub fn is_inverted(&self) -> bool

pub fn is_hidden(&self) -> bool

pub fn num_underlines(&self) -> u8

Trait Implementations

impl Clone for Chalk

fn clone(&self) -> Chalk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chalk

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

Formats the value using the given formatter.

impl Default for Chalk

fn default() -> Chalk

Returns the “default value” for a type.

impl Display for Chalk

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

Formats the value using the given formatter.

impl Hash for Chalk

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 Ord for Chalk

fn cmp(&self, other: &Chalk) -> 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 PartialEq for Chalk

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

fn partial_cmp(&self, other: &Chalk) -> 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 Eq for Chalk

impl StructuralPartialEq for Chalk