color-output 10.0.1

An atomic output library based on Rust that supports output functionalities through functions, builders, and other methods. It allows customization of text and background colors.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use crate::*;

/// Provides utilities for calculating and ensuring color contrast ratios.
///
/// Used to determine if text colors meet WCAG accessibility standards
/// when displayed on specific background colors.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ColorContrast;

/// Represents a colored text output with formatting options.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ColorOutput<'a> {
    /// The text content to output.
    pub text: &'a str,
    /// The text color.
    pub color: ColorType,
    /// The background color.
    pub bg_color: ColorType,
    /// Whether the text should be bold.
    pub bold: bool,
    /// Whether to add a newline after the text.
    pub endl: bool,
}

/// Builder pattern for constructing ColorOutput configurations.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ColorOutputBuilder<'a> {
    /// The ColorOutput configuration being built.
    pub output: ColorOutput<'a>,
}

/// Represents a list of ColorOutput configurations for sequential execution.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ColorOutputList<'a>(
    /// Collection of ColorOutput configurations to execute in sequence
    pub Vec<ColorOutput<'a>>,
);

/// Builder pattern for constructing ColorOutputList configurations.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ColorOutputListBuilder<'a> {
    /// Collection of ColorOutput configurations being built.
    pub output_list: Vec<ColorOutput<'a>>,
}