Struct WatchArgs

pub struct WatchArgs {
    pub watch: Option<Vec<PathBuf>>,
    pub no_restart: bool,
    pub run_all: bool,
    pub watch_delay: Option<String>,
}

Fields

watch: Option<Vec<PathBuf>>

Watch the given files or directories for changes.

If no paths are provided, the source and test directories of the project are watched.

no_restart: bool

Do not restart the command while it’s still running.

run_all: bool

Explicitly re-run all tests when a change is made.

By default, only the tests of the last modified test file are executed.

watch_delay: Option<String>

File update debounce delay.

During the delay, incoming change events are accumulated and only once the delay has passed, is an action taken. Note that this does not mean a command will be started: if –no-restart is given and a command is already running, the outcome of the action will be to do nothing.

Defaults to 50ms. Parses as decimal seconds by default, but using an integer with the ms suffix may be more convenient.

When using –poll mode, you’ll want a larger duration, or risk overloading disk I/O.

Implementations

impl WatchArgs

pub fn watchexec_config<PS: IntoIterator<Item = P>, P: Into<PathBuf>>( &self, default_paths: impl FnOnce() -> Result<PS>, ) -> Result<Config>

Creates a new [watchexec::Config].

If paths were provided as arguments the these will be used as the watcher’s pathset, otherwise the path the closure returns will be used.

pub fn watchexec_config_with_override<PS: IntoIterator<Item = P>, P: Into<PathBuf>>( &self, default_paths: impl FnOnce() -> Result<PS>, spawn_hook: impl Fn(&[Event], &mut TokioCommand) + Send + Sync + 'static, ) -> Result<Config>

Creates a new [watchexec::Config] with a custom command spawn hook.

If paths were provided as arguments the these will be used as the watcher’s pathset, otherwise the path the closure returns will be used.

fn watchexec_config_generic<PS: IntoIterator<Item = P>, P: Into<PathBuf>>( &self, default_paths: impl FnOnce() -> Result<PS>, spawn_hook: Option<Arc<dyn Fn(&[Event], &mut Command) + Send + Sync + 'static>>, ) -> Result<Config>

fn watchexec_config_inner( &self, paths: &[PathBuf], spawn_hook: Option<Arc<dyn Fn(&[Event], &mut Command) + Send + Sync + 'static>>, ) -> Result<Config>

Trait Implementations

impl Args for WatchArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for WatchArgs

fn clone(&self) -> WatchArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for WatchArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for WatchArgs

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

Formats the value using the given formatter.

impl Default for WatchArgs

fn default() -> WatchArgs

Returns the “default value” for a type.

impl FromArgMatches for WatchArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for WatchArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes