Struct redo::Record [−][src]
pub struct Record<R, C: Command<R>> { /* fields omitted */ }
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
#[derive(Debug)] struct Add(char); impl Command<String> for Add { type Error = Box<dyn error::Error>; fn apply(&mut self, s: &mut String) -> Result<(), Self::Error> { s.push(self.0); Ok(()) } fn undo(&mut self, s: &mut String) -> Result<(), Self::Error> { self.0 = s.pop().ok_or("`s` is empty")?; Ok(()) } } fn main() -> Result<(), Error<String, Add>> { 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"); Ok(()) }
Methods
impl<R, C: Command<R>> Record<R, C>
[src]
impl<R, C: Command<R>> Record<R, C>
pub fn new(
receiver: impl Into<R>
) -> Record<R, C>
[src]
pub fn new(
receiver: impl Into<R>
) -> Record<R, C>
Returns a new record.
pub fn builder() -> RecordBuilder<R, C>
[src]
pub fn builder() -> RecordBuilder<R, C>
Returns a builder for a record.
pub fn reserve(&mut self, additional: usize)
[src]
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
more commands.
Panics
Panics if the new capacity overflows usize.
pub fn capacity(&self) -> usize
[src]
pub fn capacity(&self) -> usize
Returns the capacity of the record.
pub fn len(&self) -> usize
[src]
pub fn len(&self) -> usize
Returns the number of commands in the record.
pub fn is_empty(&self) -> bool
[src]
pub fn is_empty(&self) -> bool
Returns true
if the record is empty.
pub fn limit(&self) -> usize
[src]
pub fn limit(&self) -> usize
Returns the limit of the record.
pub fn set_limit(&mut self, limit: usize) -> usize
[src]
pub fn set_limit(&mut self, limit: usize) -> usize
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 0 < 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 set_signal(
&mut self,
f: impl FnMut(Signal) + Send + Sync + 'static
)
[src]
pub fn set_signal(
&mut self,
f: impl FnMut(Signal) + Send + Sync + 'static
)
Sets how the signal should be handled when the state changes.
pub fn can_undo(&self) -> bool
[src]
pub fn can_undo(&self) -> bool
Returns true
if the record can undo.
pub fn can_redo(&self) -> bool
[src]
pub fn can_redo(&self) -> bool
Returns true
if the record can redo.
pub fn set_saved(&mut self, saved: bool)
[src]
pub fn set_saved(&mut self, saved: bool)
Marks the receiver as currently being in a saved or unsaved state.
pub fn is_saved(&self) -> bool
[src]
pub fn is_saved(&self) -> bool
Returns true
if the receiver is in a saved state, false
otherwise.
pub fn cursor(&self) -> usize
[src]
pub fn cursor(&self) -> usize
Returns the position of the current command.
pub fn clear(&mut self)
[src]
pub fn clear(&mut self)
Removes all commands from the record without undoing them.
pub fn apply(
&mut self,
cmd: C
) -> Result<impl Iterator<Item = C>, Error<R, C>>
[src]
pub fn apply(
&mut self,
cmd: C
) -> Result<impl Iterator<Item = C>, Error<R, C>>
Pushes the command on top of the record and executes its apply
method.
The command is merged with the previous top command if merge
does not return None
.
All commands above the active one are removed and returned as an iterator.
Errors
If an error occur when executing apply
the error is returned together with the command.
pub fn undo(&mut self) -> Option<Result<(), Error<R, C>>>
[src]
pub fn undo(&mut self) -> Option<Result<(), Error<R, 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 together with the command.
pub fn redo(&mut self) -> Option<Result<(), Error<R, C>>>
[src]
pub fn redo(&mut self) -> Option<Result<(), Error<R, 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 together with the command.
pub fn go_to(&mut self, cursor: usize) -> Option<Result<(), Error<R, C>>>
[src]
pub fn go_to(&mut self, cursor: usize) -> Option<Result<(), Error<R, C>>>
Repeatedly calls undo
or redo
until the command at cursor
is reached.
Errors
If an error occur when executing undo
or redo
the error is returned together with the command.
pub fn jump_to(&mut self, cursor: usize) -> Option<Result<(), Error<R, C>>>
[src]
pub fn jump_to(&mut self, cursor: usize) -> Option<Result<(), Error<R, C>>>
Jump directly to the command at cursor
and executes its undo
or redo
method.
This method can be used if the commands store the whole state of the receiver,
and does not require the commands in between to be called to get the same result.
Use go_to
otherwise.
Errors
If an error occur when executing undo
or redo
the error is returned together with the command.
pub fn as_receiver(&self) -> &R
[src]
pub fn as_receiver(&self) -> &R
Returns a reference to the receiver
.
pub fn as_mut_receiver(&mut self) -> &mut R
[src]
pub fn as_mut_receiver(&mut self) -> &mut R
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]
pub fn into_receiver(self) -> R
Consumes the record, returning the receiver
.
pub fn commands(
&self
) -> impl Iterator<Item = &C>
[src]
pub fn commands(
&self
) -> impl Iterator<Item = &C>
Returns an iterator over the commands in the record.
impl<R, C: Command<R> + ToString> Record<R, C>
[src]
impl<R, C: Command<R> + ToString> Record<R, C>
pub fn to_undo_string(&self) -> Option<String>
[src]
pub fn to_undo_string(&self) -> Option<String>
Returns the string of the command which will be undone in the next call to undo
.
pub fn to_redo_string(&self) -> Option<String>
[src]
pub fn to_redo_string(&self) -> Option<String>
Returns the string of the command which will be redone in the next call to redo
.
pub fn display(&self) -> Display<Self>
[src]
pub fn display(&self) -> Display<Self>
Returns a structure for configurable formatting of the record.
Trait Implementations
impl<R, C: Command<R>> From<Record<R, C>> for History<R, C>
[src]
impl<R, C: Command<R>> From<Record<R, C>> for History<R, C>
impl<R: Default, C: Command<R>> Default for Record<R, C>
[src]
impl<R: Default, C: Command<R>> Default for Record<R, C>
impl<R, C: Command<R>> AsRef<R> for Record<R, C>
[src]
impl<R, C: Command<R>> AsRef<R> for Record<R, C>
impl<R, C: Command<R>> AsMut<R> for Record<R, C>
[src]
impl<R, C: Command<R>> AsMut<R> for Record<R, C>
impl<R, C: Command<R>> From<R> for Record<R, C>
[src]
impl<R, C: Command<R>> From<R> for Record<R, C>
impl<R, C: Command<R>> From<History<R, C>> for Record<R, C>
[src]
impl<R, C: Command<R>> From<History<R, C>> for Record<R, C>
impl<R: Debug, C: Command<R> + Debug> Debug for Record<R, C>
[src]
impl<R: Debug, C: Command<R> + Debug> Debug for Record<R, C>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<R, C: Command<R> + Display> Display for Record<R, C>
[src]
impl<R, C: Command<R> + Display> Display for Record<R, C>