Struct GradientDisplay

pub struct GradientDisplay<'a, I> { /* private fields */ }

A gradient string representation.

Implementations

impl<'a, I> GradientDisplay<'a, I>

pub const fn background(self) -> Self

Colorize background.

Default is foreground.

Examples found in repository

examples/list.rs (line 50)

fn main() {
    let logo = LOGO
        .lines()
        .map(|l| format!("\t\t{}", l))
        .collect::<Vec<_>>()
        .join("\n");
    let raibow = [
        RGB::new(255, 0, 0),
        RGB::new(0, 255, 0),
        RGB::new(0, 0, 255),
    ];

    println!("{}", logo.gradient(raibow));

    println!();

    let gradients = [
        Gradient::Atlast,
        Gradient::Cristal,
        Gradient::Fruit,
        Gradient::Instagram,
        Gradient::Mind,
        Gradient::Morning,
        Gradient::Passion,
        Gradient::Pastel,
        Gradient::Rainbow,
        Gradient::Retro,
        Gradient::Summer,
        Gradient::Teen,
        Gradient::Vice,
        Gradient::Monsoon,
        Gradient::Forest,
    ];

    gradients.into_iter().for_each(|gradient| {
        let short = " ".repeat(10);
        let short = short.gradient(gradient).background();
        let long = " ".repeat(100);
        let long = long.gradient(gradient).background();
        let name = format!("{:?}", gradient);
        println!(" {:<15} {} {}", name, short, long);
    });
}

pub const fn foreground(self) -> Self

Colorize foreground.

It’s a default option.

Trait Implementations

impl<'a, I: Clone> Clone for GradientDisplay<'a, I>

fn clone(&self) -> GradientDisplay<'a, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug> Debug for GradientDisplay<'a, I>

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

Formats the value using the given formatter.

impl<I> Display for GradientDisplay<'_, I>

where I: IntoIterator<Item = RGB> + Clone, I::IntoIter: ExactSizeIterator + Clone,

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

Formats the value using the given formatter.

impl<'a, I: Ord> Ord for GradientDisplay<'a, I>

fn cmp(&self, other: &GradientDisplay<'a, I>) -> 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<'a, I: PartialEq> PartialEq for GradientDisplay<'a, I>

fn eq(&self, other: &GradientDisplay<'a, I>) -> 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<'a, I: PartialOrd> PartialOrd for GradientDisplay<'a, I>

fn partial_cmp(&self, other: &GradientDisplay<'a, I>) -> 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<'a, I: Eq> Eq for GradientDisplay<'a, I>

impl<'a, I> StructuralPartialEq for GradientDisplay<'a, I>