Enum watchexec::action::Outcome

#[non_exhaustive]
pub enum Outcome {
    DoNothing,
    Stop,
    Start,
    Wait,
    Signal(SubSignal),
    Clear,
    Reset,
    Exit,
    IfRunning(Box<Outcome>, Box<Outcome>),
    Both(Box<Outcome>, Box<Outcome>),
}

The outcome to execute when an action is triggered.

Logic against the state of the command should be expressed using these variants, rather than inside the action handler, as it ensures the state of the command is always the latest available when the outcome is executed.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DoNothing

Stop processing this action silently.

Stop

If the command is running, stop it.

This should be used with an IfRunning, and will warn if the command is not running.

Start

If the command isn’t running, start it.

This should be used with an IfRunning, and will warn if the command is running.

Wait

Wait for command completion.

Does nothing if the command isn’t running.

Signal(SubSignal)

Send this signal to the command.

This does not wait for the command to complete.

Clear

Clear the (terminal) screen.

Reset

Reset the (terminal) screen.

This invokes (in order): WindowsCooked, WindowsVt, VtLeaveAlt, VtWellDone, and the default clear.

Exit

Exit watchexec.

IfRunning(Box<Outcome>, Box<Outcome>)

When command is running, do the first, otherwise the second.

Both(Box<Outcome>, Box<Outcome>)

Do both outcomes in order.

Implementations

impl Outcome

pub fn if_running(then: Outcome, otherwise: Outcome) -> Self

Convenience function to create an outcome conditional on the state of the subprocess.

pub fn both(one: Outcome, two: Outcome) -> Self

Convenience function to create a sequence of outcomes.

pub fn wait(and_then: Outcome) -> Self

Convenience function to wait for the subprocess to complete before executing the outcome.

pub fn resolve(self, is_running: bool) -> Self

Resolves the outcome given the current state of the subprocess.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Default for Outcome

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Outcome> for Outcome

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Outcome

impl StructuralEq for Outcome

impl StructuralPartialEq for Outcome