fluent-ansi 0.4.0

A fluent interface for ANSI terminal colors and styles in Rust.
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

use core::fmt::{Display, Formatter, Result};

use enum_iterator::Sequence;

use crate::{
    Effect,
    impl_macros::{additive_styling::impl_additive_styling_type, from_to::impl_from_to},
    impl_styling_atribute_for, impl_styling_element_for,
};

pub(crate) type AllUnderlineEffects = enum_iterator::All<UnderlineEffect>;

/// An enumeration of all supported underline effects.
///
/// The values correspond to a subset of [`Effect`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Sequence)]
pub enum UnderlineEffect {
    /// Solid underline styling.
    #[default]
    Solid,
    /// Curly underline styling.
    Curly,
    /// Dotted underline styling.
    Dotted,
    /// Dashed underline styling.
    Dashed,
    /// Double underline styling.
    Double,
}

impl UnderlineEffect {
    #[must_use]
    pub(crate) fn all() -> AllUnderlineEffects {
        enum_iterator::all()
    }
}

impl_additive_styling_type!(UnderlineEffect {
    args: [self];
    to_style: { self.to_effect().to_style() }
});

impl_from_to!(
    #[doc = r"Converts the type into an [`Effect`]."]
    fn to_effect(self: UnderlineEffect) -> Effect {
        match self {
            UnderlineEffect::Solid => Effect::SolidUnderline,
            UnderlineEffect::Curly => Effect::CurlyUnderline,
            UnderlineEffect::Dotted => Effect::DottedUnderline,
            UnderlineEffect::Dashed => Effect::DashedUnderline,
            UnderlineEffect::Double => Effect::DoubleUnderline,
        }
    }
);

impl Display for UnderlineEffect {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        self.to_effect().fmt(f)
    }
}

impl_styling_element_for! { UnderlineEffect {
    args: [self, composed_styling];
    add_to: {
        composed_styling.set_underline_effect(Some(self))
    }
}}

impl_styling_atribute_for! { UnderlineEffect {
    type Value = bool;
    args: [self, composed_styling, value];

    set_in: {
        composed_styling.set_effect(self.to_effect(), value)
    }

    get_from: {
        composed_styling.get_effect(self.to_effect())
    }
}}

/// The underline attribute.
///
/// Usable in the
/// [`Style::set`](crate::Style::set)/[`Styled::set`](crate::Styled::set) and
/// [`Style::get`](crate::Style::get)/[`Styled::get`](crate::Styled::get) methods.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct UnderlineStyle;

impl_styling_atribute_for! { UnderlineStyle {
    type Value = Option<UnderlineEffect>;
    args: [self, composed_styling, value];

    set_in: {
        composed_styling.set_underline_effect(value)
    }

    get_from: {
        composed_styling.get_underline_effect()
    }
}}