Struct watchexec::config::RuntimeConfig

#[non_exhaustive]
pub struct RuntimeConfig {
    pub fs: WorkingData,
    pub action: WorkingData,
}

Runtime configuration for Watchexec.

This is used both when constructing the instance (as initial configuration) and to reconfigure it at runtime via Watchexec::reconfigure().

Use RuntimeConfig::default() to build a new one, or modify an existing one. This struct is marked non-exhaustive such that new options may be added without breaking change. You can make changes through the fields directly, or use the convenience (chainable!) methods instead.

You should see the detailed documentation on fs::WorkingData and action::WorkingData for important information and particulars about each field, especially the handlers.

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.

fs: WorkingData

Working data for the filesystem event source.

This notably includes the path set to be watched.

action: WorkingData

Working data for the action processing.

This is the task responsible for scheduling the actions in response to events, applying the filtering, etc.

Implementations

impl RuntimeConfig

pub fn pathset<I, P>(&mut self, pathset: I) -> &mut Self where
    I: IntoIterator<Item = P>,
    P: AsRef<Path>, 

Set the pathset to be watched.

pub fn file_watcher(&mut self, watcher: Watcher) -> &mut Self

Set the file watcher type to use.

pub fn action_throttle(&mut self, throttle: impl Into<Duration>) -> &mut Self

Set the action throttle.

pub fn command_shell(&mut self, shell: Shell) -> &mut Self

Set the shell to use to invoke commands.

pub fn command_grouped(&mut self, grouped: bool) -> &mut Self

Toggle whether to use process groups or not.

pub fn command<I, S>(&mut self, command: I) -> &mut Self where
    I: IntoIterator<Item = S>,
    S: AsRef<str>, 

Set the command to run on action.

pub fn filterer(&mut self, filterer: Arc<dyn Filterer>) -> &mut Self

Set the filterer implementation to use.

pub fn on_action(
    &mut self,
    handler: impl Handler<Action> + Send + 'static
) -> &mut Self

Set the action handler.

pub fn on_pre_spawn(
    &mut self,
    handler: impl Handler<PreSpawn> + Send + 'static
) -> &mut Self

Set the pre-spawn handler.

pub fn on_post_spawn(
    &mut self,
    handler: impl Handler<PostSpawn> + Send + 'static
) -> &mut Self

Set the post-spawn handler.

Trait Implementations

impl Clone for RuntimeConfig

fn clone(&self) -> RuntimeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeConfig

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

Formats the value using the given formatter.

impl Default for RuntimeConfig

fn default() -> RuntimeConfig

Returns the “default value” for a type.