Struct Text 

pub struct Text { /* private fields */ }

Styled text.

Implementations

impl Text

pub fn new(cm: ColorMode) -> Self

Examples found in repository

examples/switch.rs (line 10)

fn main() {
  let args = std::env::args().collect::<Vec<String>>();
  let color_mode = if args.len() != 2 { ColorMode::default() } else { ColorMode::new(&args[1]) };
  println!(
    "{}",
    Text::new(color_mode)
      .s("Switching colors:\n")
      .black()
      .s(" 0 ")
      .red()
      .s(" 1 ")
      .green()
      .s(" 2 ")
      .yellow()
      .s(" 3 ")
      .blue()
      .s(" 4 ")
      .magenta()
      .s(" 5 ")
      .cyan()
      .s(" 6 ")
      .white()
      .s(" 7 ")
      .reset()
  );
}

pub fn auto() -> Self

Examples found in repository

examples/hello-world.rs (line 6)

fn main() {
  let greeting = Text::auto().yellow().s("Hello").reset().s(' ').green().s("world").reset().s('!');
  println!("{}", greeting);
}

examples/basic.rs (line 22)

fn main() {
  println!(
    "{}",
    Text::auto()
      .s("Foreground colors:\n")
      .black()
      .s(" 0 ")
      .red()
      .s(" 1 ")
      .green()
      .s(" 2 ")
      .yellow()
      .s(" 3 ")
      .blue()
      .s(" 4 ")
      .magenta()
      .s(" 5 ")
      .cyan()
      .s(" 6 ")
      .white()
      .s(" 7 ")
      .reset()
  );
}

pub fn on() -> Self

Examples found in repository

examples/always.rs (line 20)

fn main() {
  println!(
    "{}",
    Text::on()
      .s("Always colored:\n")
      .black()
      .s(" 0 ")
      .red()
      .s(" 1 ")
      .green()
      .s(" 2 ")
      .yellow()
      .s(" 3 ")
      .blue()
      .s(" 4 ")
      .magenta()
      .s(" 5 ")
      .cyan()
      .s(" 6 ")
      .white()
      .s(" 7 ")
      .reset()
  );
}

pub fn off() -> Self

Examples found in repository

examples/never.rs (line 20)

fn main() {
  println!(
    "{}",
    Text::off()
      .s("Never colored:\n")
      .black()
      .s(" 0 ")
      .red()
      .s(" 1 ")
      .green()
      .s(" 2 ")
      .yellow()
      .s(" 3 ")
      .blue()
      .s(" 4 ")
      .magenta()
      .s(" 5 ")
      .cyan()
      .s(" 6 ")
      .white()
      .s(" 7 ")
      .reset()
  );
}

Trait Implementations

impl Add<&Text> for &str

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: &Text) -> Text

Performs the + operation.

impl Add<&Text> for Text

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: &Text) -> Text

Performs the + operation.

impl Add<&str> for Text

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: &str) -> Text

Performs the + operation.

impl Add<Text> for &str

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: Text) -> Text

Performs the + operation.

impl Add for Text

type Output = Text

The resulting type after applying the + operator.

fn add(self, rhs: Text) -> Text

Performs the + operation.

impl AddAssign<&Text> for Text

fn add_assign(&mut self, rhs: &Text)

Performs the += operation.

impl AddAssign<&str> for Text

fn add_assign(&mut self, rhs: &str)

Performs the += operation.

impl AddAssign for Text

fn add_assign(&mut self, rhs: Text)

Performs the += operation.

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Display for Text

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

Formats the value using the given formatter.

impl From<ColorMode> for Text

fn from(cm: ColorMode) -> Self

Converts to this type from the input type.

impl StyledText for Text

fn s<T: Display>(self, s: T) -> Self

Adds content to text.

fn reset(self) -> Self

Resets all colors and styling flags.

fn repeat<T: Display>(self, s: T, n: usize) -> Self

Adds repeated content to text.

fn plural<T: Display>(self, s: T, n: usize) -> Self

Adds s suffix to the content when the number is not 1.

fn align_left<T: Display>(self, s: T, width: usize) -> Self

Adds the content aligned left with specified width.

fn align_right<T: Display>(self, s: T, width: usize) -> Self

Adds the content aligned right with specified width.

fn align_center<T: Display>(self, s: T, width: usize) -> Self

Adds the content centered with specified width.

fn pad<T: Display>(self, ch: char, padding: usize, s: T) -> Self

Pads the content with specified character.

fn pad_left<T: Display>(self, ch: char, s: T, width: usize) -> Self

Pads the content aligned the left with specified width.

fn pad_right<T: Display>(self, ch: char, s: T, width: usize) -> Self

Pads the content aligned right with specified width.

fn pad_center<T: Display>(self, ch: char, s: T, width: usize) -> Self

Pads the content centered with specified width.

fn choose<T: Display>( self, condition: bool, when_true: T, when_false: T, ) -> Self

Adds new content based on the condition.

fn indent<T: Display>(self, indent: usize, s: T) -> Self

Adds indented content.

fn bold(self) -> Self

Style text as bold.

fn italic(self) -> Self

Style text as italic.

fn underline(self) -> Self

Style text as underlined.

fn black(self) -> Self

Sets the foreground color to black.

fn bright_black(self) -> Self

Sets the foreground color to bright black.

fn red(self) -> Self

Sets the foreground color to red.

fn bright_red(self) -> Self

Sets the foreground color to bright red.

fn green(self) -> Self

Sets the foreground color to green.

fn bright_green(self) -> Self

Sets the foreground color to bright green.

fn yellow(self) -> Self

Sets the foreground color to yellow.

fn bright_yellow(self) -> Self

Sets the foreground color to bright yellow.

fn blue(self) -> Self

Sets the foreground color to blue.

fn bright_blue(self) -> Self

Sets the foreground color to bright blue.

fn magenta(self) -> Self

Sets the foreground color to magenta.

fn bright_magenta(self) -> Self

Sets the foreground color to bright magenta.

fn cyan(self) -> Self

Sets the foreground color to cyan.

fn bright_cyan(self) -> Self

Sets the foreground color to bright cyan.

fn white(self) -> Self

Sets the foreground color to white.

fn bright_white(self) -> Self

Sets the foreground color to bright white.

fn bg_black(self) -> Self

Sets the background color to black.

fn bg_bright_black(self) -> Self

Sets the background color to bright black.

fn bg_red(self) -> Self

Sets the background color to red.

fn bg_bright_red(self) -> Self

Sets the background color to bright red.

fn bg_green(self) -> Self

Sets the background color to green.

fn bg_bright_green(self) -> Self

Sets the background color to bright green.

fn bg_yellow(self) -> Self

Sets the background color to yellow.

fn bg_bright_yellow(self) -> Self

Sets the background color to bright yellow.

fn bg_blue(self) -> Self

Sets the background color to blue.

fn bg_bright_blue(self) -> Self

Sets the background color to bright blue.

fn bg_magenta(self) -> Self

Sets the background color to magenta.

fn bg_bright_magenta(self) -> Self

Sets the background color to bright magenta.

fn bg_cyan(self) -> Self

Sets the background color to cyan.

fn bg_bright_cyan(self) -> Self

Sets the background color to bright cyan.

fn bg_white(self) -> Self

Sets the background color to white.

fn bg_bright_white(self) -> Self

Sets the background color to bright white.

fn color(self, c: Color) -> Self

Sets the color by color enumeration.

fn bright_color(self, c: Color) -> Self

Sets the bright color by color enumeration.

fn bg_color(self, c: Color) -> Self

Sets the background color by color enumeration.

fn bg_bright_color(self, c: Color) -> Self

Sets the background bright color by color enumeration.

fn color_8(self, c: u8) -> Self

Sets the color by color index.

fn bright_color_8(self, c: u8) -> Self

Sets the bright color by color index.

fn bg_color_8(self, c: u8) -> Self

Sets the background color by color index.

fn bg_bright_color_8(self, c: u8) -> Self

Sets the background bright color by color index.

fn color_256(self, c: u8) -> Self

fn bg_color_256(self, c: u8) -> Self

fn color_rgb(self, c: RgbColor) -> Self

fn bg_color_rgb(self, c: RgbColor) -> Self

fn r<T: Display>(self, s: T) -> Self

Resets all styling and then appends formatted content.