envision 0.15.1

A ratatui framework for collaborative TUI development with headless testing support
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

//! Overlay action types.

/// The result of an overlay handling an input event.
///
/// This tells the runtime what to do after an overlay processes an event.
pub enum OverlayAction<M> {
    /// Event was consumed by the overlay, stop propagation.
    Consumed,
    /// Event produced a message; keep the overlay and dispatch it through `update()`.
    KeepAndMessage(M),
    /// Dismiss (pop) this overlay, event is consumed.
    Dismiss,
    /// Dismiss this overlay and dispatch a message.
    DismissWithMessage(M),
    /// Pass the event to the next overlay or to the app.
    Propagate,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_overlay_action_variants() {
        // Verify all variants can be constructed
        let _consumed: OverlayAction<i32> = OverlayAction::Consumed;
        let _message: OverlayAction<i32> = OverlayAction::KeepAndMessage(42);
        let _dismiss: OverlayAction<i32> = OverlayAction::Dismiss;
        let _dismiss_with: OverlayAction<i32> = OverlayAction::DismissWithMessage(42);
        let _propagate: OverlayAction<i32> = OverlayAction::Propagate;
    }
}