pancurses-result 0.5.1

pancurses-result is a wrapper for pancurses that aims to provide a safe interface to curses. This library aims to guarantee thread and memory safety, whereas pancurses just provides direct C bindings.
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

use general::*;
use std::marker::PhantomData;

/// A color value represented as RGB
pub struct ColorContent {
    pub red: i16,
    pub green: i16,
    pub blue: i16,
}
impl From<(i16, i16, i16)> for ColorContent {
    fn from(p: (i16, i16, i16)) -> Self {
        ColorContent {
            red: p.0,
            green: p.1,
            blue: p.2,
        }
    }
}
impl From<ColorContent> for (i16, i16, i16) {
    fn from(color_content: ColorContent) -> (i16, i16, i16) {
        (color_content.red, color_content.green, color_content.blue)
    }
}

/// Color subsystem.  It can be accessed via [`Curses::color`].
///
/// [`Curses::color`]: struct.Curses.html#method.color
pub struct Color {
    marker: PhantomData<()>,
}

impl Color {
    pub(crate) fn new() -> Self {
        Color {
            marker: PhantomData,
        }
    }

    /// The maximum number of colors supported.
    ///
    /// This corresponds to `COLORS`.
    pub fn max_colors(&self) -> i32 {
        pancurses::COLORS()
    }
    /// Get the `n`th color pair.
    ///
    /// This corresponds to `COLOR_PAIR`.
    pub fn color_pair<T: Into<Chtype>>(&self, n: T) -> Chtype {
        pancurses::COLOR_PAIR(n.into())
    }
    /// Get the number of color pairs.
    ///
    /// This corresponds to `COLOR_PAIRS`.
    pub fn color_pairs(&self) -> i32 {
        pancurses::COLOR_PAIRS()
    }
    /// Get the [`ColorContent`] of a certain color.
    ///
    /// [`ColorContent`]: struct.ColorContent.html
    pub fn color_content(&self, color: i16) -> ColorContent {
        pancurses::color_content(color).into()
    }
    /// Is it possible to change colors?
    pub fn can_change_color(&self) -> bool {
        pancurses::can_change_color()
    }
    /// Tell the curses instance to use default colors.
    pub fn use_default_colors(&mut self) -> Result<(), ()> {
        check(pancurses::use_default_colors())
    }
    /// Set the nth color to a certain [`ColorContent`].
    ///
    /// This corresponds to `init_color`.
    ///
    /// [`ColorContent`]: struct.ColorContent.html
    pub fn set_color(&mut self, color: i16, color_content: ColorContent) -> Result<(), ()> {
        check(pancurses::init_color(
            color,
            color_content.red,
            color_content.green,
            color_content.blue,
        ))
    }
    /// Set the `color_pair` to a combination of the `foregrond` and `background` colors.
    ///
    /// This corresponds to `init_pair`.
    pub fn set_color_pair(
        &mut self,
        color_pair: i16,
        foreground: i16,
        background: i16,
    ) -> Result<(), ()> {
        check(pancurses::init_pair(color_pair, foreground, background))
    }
}