Robot/watchexec
1
0
Fork 0
mirror of https://github.com/watchexec/watchexec.git synced 2024-11-13 07:41:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add example / aspirational usage to lib doc

Browse source
This commit is contained in:
Félix Saparelli 2021-08-20 02:56:13 +12:00
parent 6a46c2bff3
commit 95ad3e91ff
No known key found for this signature in database
GPG key ID: B948C4BAE44FC474
2 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/src/config.rs
View file

@ -5,11 +5,10 @@ use derive_builder::Builder;
/// This is used both for constructing the instance and to reconfigure it at runtime, though note
/// that some fields are only applied at construction time.
///
/// You should prefer the [`ConfigBuilder`] rather than using this directly. This struct is marked
/// Use [`ConfigBuilder`] 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.
#[derive(Builder, Clone, Debug)]
#[non_exhaustive]
#[builder(build_fn(name = "finish"))]
pub struct Config {
/// Working data for the filesystem event source.
///

31
lib/src/lib.rs
View file

@ -10,6 +10,35 @@
//! running it. The config may contain some instances of [`Handler`]s, which hook into watchexec
//! processing at various points.
//!
//! ```no_compile // TODO: implement and switch to no_run
//! use watchexec::{Watchexec, ConfigBuilder, Handler as _};
//!
//! #[tokio::main]
//! async fn main() {
//! let mut config = ConfigBuilder::new()
//! config.pathset(["watchexec.conf"]);
//!
//! let conf = YourConfigFormat::load_from_file("watchexec.conf").await?;
//! conf.apply(&mut config);
//!
//! let we = Watchexec::new(config.build().unwrap()).unwrap();
//! let w = we.clone();
//!
//! let c = config.clone();
//! config.on_event(|e| async move {
//! if e.path().map(|p| p.ends_with("watchexec.conf")).unwrap_or(false) {
//! let conf = YourConfigFormat::load_from_file("watchexec.conf").await?;
//!
//! conf.apply(&mut config);
//! w.reconfigure(config.build());
//! // tada! self-reconfiguring watchexec on config file change!
//! }
//! });
//!
//! w.main().await.unwrap();
//! }
//! ```
//!
//! Alternatively, one can use the modules exposed by the crate and the external crates such as
//! [ClearScreen][clearscreen] and [Command Group][command_group] to build something more advanced,
//! at the cost of reimplementing the glue code. See the examples folder for some basic/demo tools
@ -36,7 +65,7 @@ mod handler;
mod watchexec;
#[doc(inline)]
pub use config::Config;
pub use config::{Config, ConfigBuilder};
#[doc(inline)]
pub use handler::Handler;
#[doc(inline)]