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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! Module used to communicate changes in the data structures.

use core::mem;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
#[cfg(feature = "std")]
use std::sync::mpsc::{Sender, SyncSender};

/// Slot wrapper that adds some additional functionality.
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[repr(transparent)]
#[derive(Clone, Debug)]
pub(crate) struct Socket<S>(Option<S>);

impl<S> Socket<S> {
    pub const fn new(slot: S) -> Socket<S> {
        Socket(Some(slot))
    }

    pub fn connect(&mut self, slot: Option<S>) -> Option<S> {
        mem::replace(&mut self.0, slot)
    }

    pub fn disconnect(&mut self) -> Option<S> {
        self.0.take()
    }
}

impl<S> Default for Socket<S> {
    fn default() -> Self {
        Socket(None)
    }
}

impl<S: Slot> Socket<S> {
    pub fn emit(&mut self, event: impl FnOnce() -> Event) {
        if let Some(slot) = &mut self.0 {
            slot.on_emit(event());
        }
    }

    pub fn emit_if(&mut self, cond: bool, event: impl FnOnce() -> Event) {
        if cond {
            self.emit(event);
        }
    }
}

/// Describes an event on the structures.
///
/// See [`Slot`] for more information.
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub enum Event {
    /// Emitted when the structures ability to undo has changed.
    Undo(bool),
    /// Emitted when the structures ability to redo has changed.
    Redo(bool),
    /// Emitted when the saved state has changed.
    Saved(bool),
    /// Emitted when the root has changed.
    Root(usize),
    /// Emitted when the index has changed.
    Index(usize),
}

/// Handles events.
///
/// # Examples
/// ```
/// # use std::sync::mpsc;
/// # use undo::{Add, Record, Event};
/// let (sender, receiver) = mpsc::channel();
/// let mut iter = receiver.try_iter();
///
/// let mut target = String::new();
/// let mut record = Record::builder()
///     .connect(sender)
///     .build();
///
/// record.edit(&mut target, Add('a'));
/// assert_eq!(iter.next(), Some(Event::Undo(true)));
/// assert_eq!(iter.next(), Some(Event::Saved(false)));
/// assert_eq!(iter.next(), Some(Event::Index(1)));
/// assert_eq!(iter.next(), None);
///
/// record.undo(&mut target);
/// assert_eq!(iter.next(), Some(Event::Undo(false)));
/// assert_eq!(iter.next(), Some(Event::Redo(true)));
/// assert_eq!(iter.next(), Some(Event::Saved(true)));
/// assert_eq!(iter.next(), Some(Event::Index(0)));
/// assert_eq!(iter.next(), None);
/// ```
pub trait Slot {
    /// Receives an event that describes the state change done to the structures.
    fn on_emit(&mut self, event: Event);
}

impl Slot for () {
    fn on_emit(&mut self, _: Event) {}
}

impl<F: FnMut(Event)> Slot for F {
    fn on_emit(&mut self, event: Event) {
        self(event)
    }
}

#[cfg(feature = "std")]
impl Slot for Sender<Event> {
    fn on_emit(&mut self, event: Event) {
        self.send(event).ok();
    }
}

#[cfg(feature = "std")]
impl Slot for SyncSender<Event> {
    fn on_emit(&mut self, event: Event) {
        self.send(event).ok();
    }
}