transactional_iterator 0.2.0

Iterator that allows to commit or abort progress.
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

# Transactional Iterator

A `Transaction` can be used to make changes to an iterator and only apply the changes if the
transaction is committed. When the `Transaction` is aborted, the changes are discarded. This
is useful for implementing backtracking searches, parsers, undo functionality, unlimited
peeking and more.

The original iterator must implement 'Clone' to be useable with the transactional iterator.
Transactions must be either committed or aborted, just dropping them will cause in a panic.

## Feature Flags

Transactions must be either committed or aborted. By default this is enforced with the
'panic_on_drop' feature flag. Disabling this feature flag allows transactions to be silently
dropped which aborts the transaction.

## Example

```rust
use transactional_iterator::Transaction;

let mut iter = vec![1, 2, 3].into_iter();
let mut transaction = Transaction::new(&mut iter);

// iterate within the transaction
assert_eq!(transaction.next(), Some(1));
assert_eq!(transaction.next(), Some(2));

// Commit the transaction
transaction.commit();

// The changes are now applied
assert_eq!(iter.next(), Some(3));
```