Struct undo::timeline::Timeline

pub struct Timeline<C, const LIMIT: usize> { /* fields omitted */ }

A timeline of commands.

A timeline works mostly like a record but stores a fixed number of commands on the stack.

Can be used without the alloc feature.

Examples

let mut target = String::new();
let mut timeline = Timeline::<_, 32>::new();
timeline.apply(&mut target, Add('a'))?;
timeline.apply(&mut target, Add('b'))?;
timeline.apply(&mut target, Add('c'))?;
assert_eq!(target, "abc");
timeline.undo(&mut target)?;
timeline.undo(&mut target)?;
timeline.undo(&mut target)?;
assert_eq!(target, "");
timeline.redo(&mut target)?;
timeline.redo(&mut target)?;
timeline.redo(&mut target)?;
assert_eq!(target, "abc");

Implementations

impl<C, const LIMIT: usize> Timeline<C, LIMIT>

pub fn new() -> Timeline<C, LIMIT>

Returns a new timeline.

impl<C, const LIMIT: usize> Timeline<C, LIMIT>

pub fn len(&self) -> usize

Returns the number of commands in the timeline.

pub fn is_empty(&self) -> bool

Returns true if the timeline is empty.

pub fn can_undo(&self) -> bool

Returns true if the timeline can undo.

pub fn can_redo(&self) -> bool

Returns true if the timeline can redo.

pub fn is_saved(&self) -> bool

Returns true if the target is in a saved state, false otherwise.

pub fn current(&self) -> usize

Returns the position of the current command.

pub fn display(&self) -> Display<'_, C, LIMIT>

Returns a structure for configurable formatting of the record.

impl<C: Command, const LIMIT: usize> Timeline<C, LIMIT>

pub fn apply(&mut self, target: &mut C::Target, command: C) -> Result<C>

Pushes the command on top of the timeline and executes its apply method.

Errors

If an error occur when executing apply the error is returned.

pub fn undo(&mut self, target: &mut C::Target) -> Result<C>

Calls the undo method for the active command and sets the previous one as the new active one.

Errors

If an error occur when executing undo the error is returned.

pub fn redo(&mut self, target: &mut C::Target) -> Result<C>

Calls the redo method for the active command and sets the next one as the new active one.

Errors

If an error occur when applying redo the error is returned.

pub fn go_to(
    &mut self,
    target: &mut C::Target,
    current: usize
) -> Option<Result<C>>

Repeatedly calls undo or redo until the command at current is reached.

Errors

If an error occur when executing undo or redo the error is returned.

pub fn time_travel(
    &mut self,
    target: &mut C::Target,
    to: &DateTime<impl TimeZone>
) -> Option<Result<C>>

Go back or forward in the record to the command that was made closest to the datetime provided.

pub fn set_saved(&mut self, saved: bool)

Marks the target as currently being in a saved or unsaved state.

pub fn revert(&mut self, target: &mut C::Target) -> Option<Result<C>>

Revert the changes done to the target since the saved state.

pub fn clear(&mut self)

Removes all commands from the timeline without undoing them.

impl<C: ToString, const LIMIT: usize> Timeline<C, LIMIT>

pub fn undo_text(&self) -> Option<String>

Returns the string of the command which will be undone in the next call to undo.

pub fn redo_text(&self) -> Option<String>

Returns the string of the command which will be redone in the next call to redo.

Trait Implementations

impl<C: Clone, const LIMIT: usize> Clone for Timeline<C, LIMIT>

fn clone(&self) -> Timeline<C, LIMIT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, const LIMIT: usize> Debug for Timeline<C, LIMIT>

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

Formats the value using the given formatter.

impl<C, const LIMIT: usize> Default for Timeline<C, LIMIT>

fn default() -> Timeline<C, LIMIT>

Returns the “default value” for a type.

impl<'de, C, const LIMIT: usize> Deserialize<'de> for Timeline<C, LIMIT> where
    C: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<'a, C, const LIMIT: usize> From<&'a Timeline<C, LIMIT>> for Display<'a, C, LIMIT>

fn from(timeline: &'a Timeline<C, LIMIT>) -> Self

Performs the conversion.

impl<C, const LIMIT: usize> Serialize for Timeline<C, LIMIT> where
    C: Serialize, 

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

Serialize this value into the given Serde serializer.