Struct Style 

pub struct Style { /* private fields */ }

Available on crate feature std only.

A piece of text together with the color and attributes to render it with.

Created by style. The setter methods consume and return self, so they chain. Style implements Display: passing one to out renders it, and the color depth matches whatever the terminal supports.

Examples

use cli_forge::{out, style};

out(style("done").green().bold());
out(style("note").hex("#88aaff"));
out(style("ok").rgb(0, 200, 120));

Implementations

impl Style

pub fn black(self) -> Style

Set the foreground to the standard black.

pub fn red(self) -> Style

Set the foreground to the standard red.

pub fn green(self) -> Style

Set the foreground to the standard green.

pub fn yellow(self) -> Style

Set the foreground to the standard yellow.

pub fn blue(self) -> Style

Set the foreground to the standard blue.

pub fn magenta(self) -> Style

Set the foreground to the standard magenta.

pub fn cyan(self) -> Style

Set the foreground to the standard cyan.

pub fn white(self) -> Style

Set the foreground to the standard white.

pub fn hex(self, hex: &str) -> Style

Set the foreground to a 24-bit hex color, e.g. "#ff8800".

The leading # is optional; the rest must be exactly six hex digits. An invalid string leaves the current color unchanged, so the builder never fails. On terminals without 24-bit support the color is downgraded to the nearest representable value at render time.

Examples

use cli_forge::style;

let link = style("https://example.com").hex("#3b82f6").underline();
assert!(link.render().contains("https://example.com"));

// An invalid hex string is ignored rather than panicking.
let plain = style("x").hex("nope");
assert_eq!(plain.render(), "x");

pub fn rgb(self, r: u8, g: u8, b: u8) -> Style

Set the foreground to a 24-bit RGB color.

On terminals without 24-bit support the color is downgraded to the nearest representable value at render time.

Examples

use cli_forge::style;

let teal = style("ok").rgb(0, 200, 120);
assert!(teal.render().contains("ok"));

pub fn bold(self) -> Style

Render the text in bold.

Examples

use cli_forge::style;

let heading = style("Summary").bold();
assert!(heading.render().contains("Summary"));

pub fn underline(self) -> Style

Underline the text.

Examples

use cli_forge::style;

let link = style("docs").underline();
assert!(link.render().contains("docs"));

pub fn render(&self) -> String

Render to an owned String, ready to print or store.

Equivalent to formatting the Style via its Display implementation. The color depth matches the terminal detected for standard output, so on a pipe or a NO_COLOR environment the result is the plain text.

Examples

use cli_forge::style;

let s = style("ready").green().render();
assert!(s.contains("ready"));

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Display for Style

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

Formats the value using the given formatter.