Enum HistoryEdit 

pub enum HistoryEdit {
    Undo {
        steps: Option<u32>,
        run: Option<String>,
        by: Option<String>,
        to: Option<String>,
        step: Option<String>,
    },
    Redo {
        steps: Option<u32>,
    },
    Restore {
        version: String,
        ids: Option<Vec<String>>,
    },
    RestoreReviewed {
        review: RestoreReview,
    },
    Checkpoint {
        name: String,
    },
}

A history verb that writes the document.

Variants

Undo

Fields

steps: Option<u32>

run: Option<String>

by: Option<String>

An exact author id from history for steps outside a run.

to: Option<String>

Every step after this version instead.

step: Option<String>

Only the step this change id from history is part of, wherever it stands, instead.

Redo

Fields

steps: Option<u32>

Restore

Fields

version: String

ids: Option<Vec<String>>

RestoreReviewed

Fields

review: RestoreReview

Checkpoint

Fields

name: String

Implementations

impl HistoryEdit

pub const fn verb(&self) -> &'static str

The verb it is, as it is published.

pub fn change_kind(&self) -> ChangeKind

A checkpoint is housekeeping; any other move through history is a step of its own.

pub fn described(&self, doc: &AutoCommit) -> Described

What history records this step through history did: for an undo of one step, the step it takes back.

impl HistoryEdit

pub fn apply_registered( &self, doc: &mut AutoCommit, register: fn(&mut ActionRegistry), words: &dyn HistoryWords, ) -> Result<(), ActionError>

Apply the edit, decoding recorded actions with the registry register fills: one compiled copy for every resource.

Errors

Why nothing was done, in words, as steps says it.

Trait Implementations

impl Clone for HistoryEdit

fn clone(&self) -> HistoryEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryEdit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HistoryEdit

fn deserialize<__D>( __deserializer: __D, ) -> Result<HistoryEdit, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HistoryEdit

fn eq(&self, other: &HistoryEdit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HistoryEdit

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HistoryEdit

impl StructuralPartialEq for HistoryEdit