Struct watchexec::config::RuntimeConfig
source · [−]#[non_exhaustive]pub struct RuntimeConfig {
pub fs: WorkingData,
pub action: WorkingData,
}
Expand description
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)
This struct is marked as non-exhaustive
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
Set the pathset to be watched.
Set the file watcher type to use.
Set the action throttle.
Set the shell to use to invoke commands.
Toggle whether to use process groups or not.
Set the command to run on action.
Set the filterer implementation to use.
Set the action handler.
Keep the action handler the same.
This is especially useful when reconfiguring within the action handler.
Passing this config to Watchexec::new()
will cause a
CriticalError::MissingHandler
.
Set the pre-spawn handler.
Keep the pre-spawn handler the same.
This is especially useful when reconfiguring within the action handler.
Passing this config to Watchexec::new()
will cause a
CriticalError::MissingHandler
.
Set the post-spawn handler.
Keep the post-spawn handler the same.
This is especially useful when reconfiguring within the action handler.
Passing this config to Watchexec::new()
will cause a
CriticalError::MissingHandler
.
Trait Implementations
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl !RefUnwindSafe for RuntimeConfig
impl Send for RuntimeConfig
impl Sync for RuntimeConfig
impl Unpin for RuntimeConfig
impl !UnwindSafe for RuntimeConfig
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more