notcurses 3.6.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
104
105
106
107

// notcurses::input::received
//
//!
//

use super::Key;

/// A received [`char`] or [`Key`].
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Received {
    /// No input was received.
    ///
    /// A `0x00` (NUL) was received, meaning no input.
    NoInput,

    /// A synthesized event was received.
    Key(Key),

    /// A valid [`char`] was received.
    Char(char),
}

impl Received {
    /// Returns `true` if a specific `Key` has been received.
    #[inline]
    pub fn is_key(&self, key: Key) -> bool {
        matches!(self, Self::Key(k) if *k == key)
    }

    /// Returns `true` if a specific `char` has been received.
    #[inline]
    pub const fn is_char(&self, c: char) -> bool {
        matches!(self, Self::Char(ch) if *ch == c)
    }

    /// Returns the received `Key`, if any.
    #[inline]
    pub const fn key(&self) -> Option<Key> {
        if let Self::Key(k) = self {
            Some(*k)
        } else {
            None
        }
    }

    /// Returns the received `char`, if any.
    #[inline]
    pub const fn char(&self) -> Option<char> {
        if let Self::Char(c) = self {
            Some(*c)
        } else {
            None
        }
    }
}

mod core_impls {
    use super::Received;
    use crate::sys::NcReceived;
    use core::fmt;

    impl Default for Received {
        fn default() -> Self {
            Self::NoInput
        }
    }

    impl fmt::Display for Received {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            let string = match self {
                Received::Key(k) => format!["{k}"],
                Received::Char(c) => format!["{c:?}"],
                Received::NoInput => "NoInput".to_string(),
            };
            write!(f, "{}", string)
        }
    }
    impl fmt::Debug for Received {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            let string = match self {
                Received::Key(k) => format!["Key({k})"],
                Received::Char(c) => format!["Char({c:?})"],
                Received::NoInput => "NoInput".to_string(),
            };
            write!(f, "Received::{}", string)
        }
    }

    impl From<NcReceived> for Received {
        fn from(nc: NcReceived) -> Self {
            match nc {
                NcReceived::NoInput => Received::NoInput,
                NcReceived::Key(k) => Received::Key(k.into()),
                NcReceived::Char(c) => Received::Char(c),
            }
        }
    }
    impl From<Received> for NcReceived {
        fn from(r: Received) -> Self {
            match r {
                Received::NoInput => NcReceived::NoInput,
                Received::Key(k) => NcReceived::Key(k.into()),
                Received::Char(c) => NcReceived::Char(c),
            }
        }
    }
}