notcurses 3.1.0

A high level Rust wrapper for the notcurses C library
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
102
103

// notcurses::color::alpha
//
//!
//

/// Alpha information, part of a [`Channel`][super::Channel].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Alpha {
    /// Indicates a [`Cell`][crate::plane::Cell]'s foreground or background color
    /// is used unchanged.
    ///
    /// This is the default.
    Opaque,

    /// Indicates a [`Cell`][crate::plane::Cell]'s foreground or background color
    /// is derived entirely from the `Cell`s underneath it.
    Transparent,

    /// Indicates a [`Cell`][crate::plane::Cell]'s foreground or background color will
    /// be a composite between its color and the `Cell`s' corresponding colors.
    Blend,

    /// Indicates the foreground color will be high-contrast,
    /// relative to the computed background.
    ///
    /// The background cannot be high-contrast.
    HighContrast,
}

mod std_impls {
    use super::Alpha;
    use crate::sys::{c_api::NcAlpha_u32, NcAlpha};
    use std::fmt;

    impl Default for Alpha {
        fn default() -> Self {
            Self::Opaque
        }
    }

    impl fmt::Display for Alpha {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            use Alpha::*;
            write!(
                f,
                "{}",
                match self {
                    Opaque => "Opaque",
                    Transparent => "Transparent",
                    Blend => "Blend",
                    HighContrast => "HighContrast",
                }
            )
        }
    }

    //

    impl From<NcAlpha> for Alpha {
        fn from(nc: NcAlpha) -> Alpha {
            match nc {
                NcAlpha::Opaque => Alpha::Opaque,
                NcAlpha::Transparent => Alpha::Transparent,
                NcAlpha::Blend => Alpha::Blend,
                NcAlpha::HighContrast => Alpha::HighContrast,
            }
        }
    }
    impl From<Alpha> for NcAlpha {
        fn from(alpha: Alpha) -> NcAlpha {
            match alpha {
                Alpha::Opaque => NcAlpha::Opaque,
                Alpha::Transparent => NcAlpha::Transparent,
                Alpha::Blend => NcAlpha::Blend,
                Alpha::HighContrast => NcAlpha::HighContrast,
            }
        }
    }

    impl From<NcAlpha_u32> for Alpha {
        fn from(ncu: NcAlpha_u32) -> Alpha {
            NcAlpha::from(ncu).into()
        }
    }
    impl From<Alpha> for NcAlpha_u32 {
        fn from(align: Alpha) -> NcAlpha_u32 {
            NcAlpha::from(align).into()
        }
    }
}

impl Alpha {
    /// Displays the short name identifier of the alpha value.
    pub fn display_short(&self) -> &str {
        use Alpha::*;
        match self {
            Blend => "B",
            HighContrast => "H",
            Opaque => "O",
            Transparent => "T",
        }
    }
}