ratatui-which-key 0.4.2

A which-key popup widget for ratatui applications
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

// Copyright (C) 2026 Jayson Lennon
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <https://opensource.org/license/lgpl-3-0>.

/// Result of handling a crossterm event.
#[derive(Debug, Clone)]
pub enum EventResult<A> {
    /// Key event was processed.
    Key(Option<A>),
    /// Mouse event was processed.
    Mouse(Option<A>),
    /// Resize event was processed.
    Resize(Option<A>),
    /// Focus gained event was processed.
    FocusGained(Option<A>),
    /// Focus lost event was processed.
    FocusLost(Option<A>),
    /// Event was not handled.
    Unhandled,
}

impl<A> EventResult<A> {
    /// Returns a reference to the action, if any.
    pub fn action(&self) -> Option<&A> {
        match self {
            EventResult::Key(a)
            | EventResult::Mouse(a)
            | EventResult::Resize(a)
            | EventResult::FocusGained(a)
            | EventResult::FocusLost(a) => a.as_ref(),
            EventResult::Unhandled => None,
        }
    }

    /// Returns true if an action was produced.
    pub fn has_action(&self) -> bool {
        self.action().is_some()
    }

    /// Converts into the action, if any.
    pub fn into_action(self) -> Option<A> {
        match self {
            EventResult::Key(a)
            | EventResult::Mouse(a)
            | EventResult::Resize(a)
            | EventResult::FocusGained(a)
            | EventResult::FocusLost(a) => a,
            EventResult::Unhandled => None,
        }
    }
}