promkit 0.9.1

A toolkit for building your own interactive command-line tools
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

use std::cell::{Ref, RefCell};

use promkit_core::{Pane, PaneFactory};

/// A `Snapshot` struct captures the state of a renderer at three different points:
/// initial (`init`), before any changes (`before`), and after changes have been applied (`after`).
/// It is generic over `R` where `R` must implement the `Renderer` and `Clone` traits.
#[derive(Clone)]
pub struct Snapshot<R: PaneFactory + Clone> {
    init: R,
    before: RefCell<R>,
    after: R,
}

impl<R: PaneFactory + Clone + 'static> PaneFactory for Snapshot<R> {
    fn create_pane(&self, width: u16, height: u16) -> Pane {
        *self.before.borrow_mut() = self.after.clone();
        self.after.create_pane(width, height)
    }
}

impl<R: PaneFactory + Clone + 'static> Snapshot<R> {
    /// Constructs a new `Snapshot` instance with the given renderer. The `init`, `before`, and
    /// `after` states are all initialized with clones of the provided renderer.
    pub fn new(renderer: R) -> Self {
        Self {
            init: renderer.clone(),
            before: RefCell::new(renderer.clone()),
            after: renderer,
        }
    }

    /// Returns a reference to the initial state (`init`) of the renderer.
    pub fn init(&self) -> &R {
        &self.init
    }

    /// Returns a reference to the state of the renderer before any changes were applied (`before`).
    pub fn borrow_before(&self) -> Ref<R> {
        self.before.borrow()
    }

    /// Returns a reference to the state of the renderer after changes have been applied (`after`).
    pub fn after(&self) -> &R {
        &self.after
    }

    /// Returns a mutable reference to the state of the renderer after changes have been applied (`after`).
    /// This allows for modifications to the `after` state.
    pub fn after_mut(&mut self) -> &mut R {
        &mut self.after
    }

    /// Resets the `after` state to match the initial state (`init`). This method can be used to
    /// revert any changes made during the rendering cycle.
    pub fn reset_after_to_init(&mut self) {
        self.after = self.init.clone();
    }
}