tui-lipan 0.1.0

Opinionated, component-based TUI framework for Rust - declarative components, reconciliation, layout engine, focus, overlays, and rich widgets on top of ratatui.
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

use std::cell::RefCell;
use std::rc::Rc;

use super::UiSnapshot;

/// Slot that receives a UI snapshot after the next render in a live app.
#[derive(Clone, Default)]
pub struct UiSnapshotSlot {
    inner: Rc<RefCell<Option<UiSnapshot>>>,
}

impl UiSnapshotSlot {
    /// Create an empty snapshot slot.
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns `true` when a snapshot has been delivered and not yet taken.
    pub fn is_ready(&self) -> bool {
        self.inner.borrow().is_some()
    }

    /// Returns and clears the delivered snapshot, if any.
    pub fn take(&self) -> Option<UiSnapshot> {
        self.inner.borrow_mut().take()
    }

    pub(crate) fn shared(&self) -> Rc<RefCell<Option<UiSnapshot>>> {
        Rc::clone(&self.inner)
    }
}