[−][src]Struct undo::Record
A record of commands.
The record can roll the receivers state backwards and forwards by using
the undo and redo methods. In addition, the record can notify the user
about changes to the stack or the receiver through signal. The user
can give the record a function that is called each time the state changes
by using the builder
.
Examples
let mut record = Record::default(); record.apply(Add('a'))?; record.apply(Add('b'))?; record.apply(Add('c'))?; assert_eq!(record.as_receiver(), "abc"); record.undo().unwrap()?; record.undo().unwrap()?; record.undo().unwrap()?; assert_eq!(record.as_receiver(), ""); record.redo().unwrap()?; record.redo().unwrap()?; record.redo().unwrap()?; assert_eq!(record.as_receiver(), "abc");
Methods
impl<R> Record<R>
[src]
pub fn new(receiver: impl Into<R>) -> Record<R>
[src]
Returns a new record.
pub fn builder() -> RecordBuilder<R>
[src]
Returns a builder for a record.
pub fn reserve(&mut self, additional: usize)
[src]
Reserves capacity for at least additional
more commands.
Panics
Panics if the new capacity overflows usize.
pub fn capacity(&self) -> usize
[src]
Returns the capacity of the record.
pub fn shrink_to_fit(&mut self)
[src]
Shrinks the capacity of the record as much as possible.
pub fn len(&self) -> usize
[src]
Returns the number of commands in the record.
pub fn is_empty(&self) -> bool
[src]
Returns true
if the record is empty.
pub fn limit(&self) -> usize
[src]
Returns the limit of the record.
pub fn set_limit(&mut self, limit: usize) -> usize
[src]
Sets the limit of the record and returns the new limit.
If this limit is reached it will start popping of commands at the beginning of the record when new commands are applied. No limit is set by default which means it may grow indefinitely.
If limit < len
the first commands will be removed until len == limit
.
However, if the current active command is going to be removed, the limit is instead
adjusted to len - active
so the active command is not removed.
Panics
Panics if limit
is 0
.
pub fn connect(
&mut self,
slot: impl FnMut(Signal) + 'static
) -> Option<impl FnMut(Signal) + 'static>
[src]
&mut self,
slot: impl FnMut(Signal) + 'static
) -> Option<impl FnMut(Signal) + 'static>
Sets how the signal should be handled when the state changes.
The previous slot is returned if it exists.
pub fn disconnect(&mut self) -> Option<impl FnMut(Signal) + 'static>
[src]
Removes and returns the slot.
pub fn can_undo(&self) -> bool
[src]
Returns true
if the record can undo.
pub fn can_redo(&self) -> bool
[src]
Returns true
if the record can redo.
pub fn set_saved(&mut self, saved: bool)
[src]
Marks the receiver as currently being in a saved or unsaved state.
pub fn is_saved(&self) -> bool
[src]
Returns true
if the receiver is in a saved state, false
otherwise.
pub fn revert(&mut self) -> Option<Result>
[src]
Revert the changes done to the receiver since the saved state.
pub fn current(&self) -> usize
[src]
Returns the position of the current command.
pub fn clear(&mut self)
[src]
Removes all commands from the record without undoing them.
pub fn apply(&mut self, command: impl Command<R> + 'static) -> Result where
R: 'static,
[src]
R: 'static,
Pushes the command to the top of the record and executes its apply
method.
Errors
If an error occur when executing apply
the error is returned.
pub fn undo(&mut self) -> Option<Result>
[src]
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) -> Option<Result>
[src]
Calls the redo
method for the active command and sets the next one as the
new active one.
Errors
If an error occur when executing redo
the error is returned.
pub fn go_to(&mut self, current: usize) -> Option<Result>
[src]
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, to: &DateTime<impl TimeZone>) -> Option<Result>
[src]
Go back or forward in the record to the command that was made closest to the datetime provided.
pub fn extend<C: Command<R> + 'static>(
&mut self,
commands: impl IntoIterator<Item = C>
) -> Result where
R: 'static,
[src]
&mut self,
commands: impl IntoIterator<Item = C>
) -> Result where
R: 'static,
Applies each command in the iterator.
Errors
If an error occur when executing apply
the error is returned
and the remaining commands in the iterator are discarded.
pub fn checkpoint(&mut self) -> Checkpoint<Record<R>, R>
[src]
Returns a checkpoint.
pub fn queue(&mut self) -> Queue<Record<R>, R>
[src]
Returns a queue.
pub fn to_undo_string(&self) -> Option<String>
[src]
Returns the string of the command which will be undone in the next call to undo
.
Requires the display
feature to be enabled.
pub fn to_redo_string(&self) -> Option<String>
[src]
Returns the string of the command which will be redone in the next call to redo
.
Requires the display
feature to be enabled.
pub fn display(&self) -> Display<Self>
[src]
Returns a structure for configurable formatting of the record.
Requires the display
feature to be enabled.
pub fn as_receiver(&self) -> &R
[src]
Returns a reference to the receiver
.
pub fn as_mut_receiver(&mut self) -> &mut R
[src]
Returns a mutable reference to the receiver
.
This method should only be used when doing changes that should not be able to be undone.
pub fn into_receiver(self) -> R
[src]
Consumes the record, returning the receiver
.
Trait Implementations
impl<R> AsRef<R> for Record<R>
[src]
impl<R> AsMut<R> for Record<R>
[src]
impl<R> From<Record<R>> for History<R>
[src]
impl<R> From<R> for Record<R>
[src]
impl<R> From<History<R>> for Record<R>
[src]
impl<R: Default> Default for Record<R>
[src]
impl<R> Display for Record<R>
[src]
impl<R: Debug> Debug for Record<R>
[src]
Auto Trait Implementations
impl<R> !Send for Record<R>
impl<R> !Sync for Record<R>
impl<R> Unpin for Record<R> where
R: Unpin,
R: Unpin,
impl<R> !UnwindSafe for Record<R>
impl<R> !RefUnwindSafe for Record<R>
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<!> for T
[src]
impl<T> From<T> for T
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,