Skip to content

Commit 7e3b49b

Browse files
author
Markus Westerlind
committedApr 7, 2020
doc: Explain the opaqueness of T in UndoLogs<T>
1 parent c0ab90a commit 7e3b49b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed
 

‎src/undo_log.rs

+5-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88
//! Since the `*Storage` variants do not have an undo log `with_log` must be called with the
99
//! unified log before any mutating actions.
1010
11-
/// A trait which allows actions (`T`) to be pushed which which allows the action to be undone at a
12-
/// later time if needed
11+
/// A trait which allows undo actions (`T`) to be pushed which can be used to rollback actio at a
12+
/// later time if needed.
13+
///
14+
/// The undo actions themselves are opaque to `UndoLogs`, only specified `Rollback` implementations
15+
/// need to know what an action is and how to reverse it.
1316
pub trait UndoLogs<T> {
1417
/// True if a snapshot has started, false otherwise
1518
fn in_snapshot(&self) -> bool {

0 commit comments

Comments
 (0)
Please sign in to comment.