undo 0.52.0

An undo-redo 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

use crate::record::Builder as RecordBuilder;
use crate::History;

/// Builder for a [`History`].
///
/// # Examples
/// ```
/// # use undo::{Add, History};
/// # let mut target = String::new();
/// let mut history = History::builder()
///     .limit(100)
///     .capacity(100)
///     .connect(|s| { dbg!(s); })
///     .build();
/// # history.edit(&mut target, Add('a'));
/// ```
#[derive(Debug)]
pub struct Builder<E, S = ()>(RecordBuilder<E, S>);

impl<E, S> Builder<E, S> {
    /// Sets the capacity for the history.
    pub fn capacity(self, capacity: usize) -> Builder<E, S> {
        Builder(self.0.capacity(capacity))
    }

    /// Sets the `limit` for the history.
    ///
    /// # Panics
    /// Panics if `limit` is `0`.
    pub fn limit(self, limit: usize) -> Builder<E, S> {
        Builder(self.0.limit(limit))
    }

    /// Sets if the target is initially in a saved state.
    /// By default the target is in a saved state.
    pub fn saved(self, saved: bool) -> Builder<E, S> {
        Builder(self.0.saved(saved))
    }

    /// Connects the slot.
    pub fn connect(self, slot: S) -> Builder<E, S> {
        Builder(self.0.connect(slot))
    }

    /// Builds the history.
    pub fn build(self) -> History<E, S> {
        History::from(self.0.build())
    }
}

impl<E, S> Default for Builder<E, S> {
    fn default() -> Self {
        Builder(RecordBuilder::default())
    }
}