Skip to main content

CompoundCommand

Struct CompoundCommand 

Source
pub struct CompoundCommand<C> { /* private fields */ }
Expand description

A group of commands executed as a single undo/redo unit.

Commands are applied in order and reversed in reverse order (matching shruti’s Compound variant behaviour). If a sub-command fails during apply, all previously-applied sub-commands are rolled back (best-effort).

Implementations§

Source§

impl<C> CompoundCommand<C>

Source

pub fn new(description: &'static str, commands: Vec<C>) -> Self

Create a compound command with a static description.

Source

pub fn with_description(description: String, commands: Vec<C>) -> Self

Create a compound command with a dynamic description.

Source

pub fn len(&self) -> usize

Number of sub-commands.

Source

pub fn is_empty(&self) -> bool

Whether this compound command has no sub-commands.

Source

pub fn commands(&self) -> &[C]

Access the sub-commands.

Trait Implementations§

Source§

impl<C: Clone> Clone for CompoundCommand<C>

Source§

fn clone(&self) -> CompoundCommand<C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Command> Command for CompoundCommand<C>

Source§

type Target = <C as Command>::Target

The state this command operates on (e.g. a session, timeline, canvas).
Source§

type Error = <C as Command>::Error

Error type. Use std::convert::Infallible for infallible commands.
Source§

fn apply(&mut self, target: &mut Self::Target) -> Result<(), Self::Error>

Apply the command to the target. Read more
Source§

fn reverse(&mut self, target: &mut Self::Target) -> Result<(), Self::Error>

Reverse the command, restoring the target to its prior state.
Source§

fn description(&self) -> &str

Human-readable description for undo/redo menu display.
Source§

impl<C: Debug> Debug for CompoundCommand<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for CompoundCommand<C>

§

impl<C> RefUnwindSafe for CompoundCommand<C>
where C: RefUnwindSafe,

§

impl<C> Send for CompoundCommand<C>
where C: Send,

§

impl<C> Sync for CompoundCommand<C>
where C: Sync,

§

impl<C> Unpin for CompoundCommand<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for CompoundCommand<C>

§

impl<C> UnwindSafe for CompoundCommand<C>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more