Struct Transaction 

pub struct Transaction { /* private fields */ }

A transaction groups multiple edits for atomic undo/redo.

When a transaction is undone, all its edits are reversed in reverse order. When redone, all edits are applied in original order.

Example

use reovim_kernel::api::v1::*;

let mut txn = Transaction::new();
txn.push(Edit::insert(Position::new(0, 0), "Hello"));
txn.push(Edit::insert(Position::new(0, 5), " World"));

assert_eq!(txn.len(), 2);
assert!(!txn.is_empty());

// Get inverse for undo
let inverse = txn.inverse();
assert_eq!(inverse.len(), 2);
// Inverse edits are in reverse order

Implementations

impl Transaction

pub const fn new() -> Self

Create a new empty transaction.

pub fn iter(&self) -> Iter<'_, Edit>

Returns an iterator over the edits.

pub fn with_capacity(capacity: usize) -> Self

Create a transaction with pre-allocated capacity.

pub fn push(&mut self, edit: Edit)

Add an edit to this transaction.

pub fn edits(&self) -> &[Edit]

Get all edits in this transaction.

pub fn into_edits(self) -> Vec<Edit>

Consume the transaction and return the edits.

pub const fn is_empty(&self) -> bool

Check if this transaction has no edits.

pub const fn len(&self) -> usize

Get the number of edits in this transaction.

pub fn inverse(&self) -> Self

Create the inverse of this transaction (for undo).

The inverse contains the inverse of each edit, in reverse order. Applying the inverse undoes the original transaction.

pub fn clear(&mut self)

Clear all edits from this transaction.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Transaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Transaction

fn default() -> Transaction

Returns the “default value” for a type.

impl From<Edit> for Transaction

fn from(edit: Edit) -> Self

Converts to this type from the input type.

impl From<Vec<Edit>> for Transaction

fn from(edits: Vec<Edit>) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Transaction

type Item = &'a Edit

The type of the elements being iterated over.

type IntoIter = Iter<'a, Edit>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Transaction

type Item = Edit

The type of the elements being iterated over.

type IntoIter = IntoIter<Edit>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.