Struct watchexec::action::PreSpawn

#[non_exhaustive]
pub struct PreSpawn {
    pub command: Vec<String>,
    pub events: Arc<Vec<Event>>,
    // some fields omitted
}

The environment given to the pre-spawn handler.

This deliberately does not implement Clone to make it hard to move it out of the handler, which you should not do.

The PreSpawn::command() method is the only way to mutate the command, and the mutex guard it returns must be dropped before the handler returns.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

command: Vec<String>

The command which is about to be spawned.

This is the final command, after the Shell has been applied.

events: Arc<Vec<Event>>

The collected events which triggered the action this command issues from.

Implementations

impl PreSpawn

pub async fn command(&self) -> Option<OwnedMutexGuard<Command>>

Get write access to the command that will be spawned.

Keeping the lock alive beyond the end of the handler may cause the command to be cancelled, but note no guarantees are made on this behaviour. Just don’t do it. See the Action documentation about handlers for more.

This will always return Some() under normal circumstances.

Trait Implementations

impl Debug for PreSpawn

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

Formats the value using the given formatter.