watchexec/lib/src/lib.rs

35 lines
1,015 B
Rust
Raw Normal View History

2021-08-16 11:49:12 +02:00
//! Watchexec: a library for utilities and programs which respond to events;
//! file changes, human interaction, and more.
2019-10-27 10:54:44 +01:00
//!
2021-08-16 11:49:12 +02:00
//! Also see the CLI tool: https://watchexec.github.io/
2019-10-27 11:29:58 +01:00
//!
2021-08-16 11:49:12 +02:00
//! This library is powered by [Tokio](https://tokio.rs), minimum version 1.10.
//!
//! The main way to use this crate involves constructing a [`Handler`] and running it.
//!
//! This crate does not itself use `unsafe`. However, it depends on a number of libraries which do,
//! most because they interact with the operating system.
2019-10-27 10:54:44 +01:00
2021-07-20 10:32:38 +02:00
#![doc(html_favicon_url = "https://watchexec.github.io/logo:watchexec.svg")]
#![doc(html_logo_url = "https://watchexec.github.io/logo:watchexec.svg")]
2021-04-10 19:44:24 +02:00
#![warn(clippy::unwrap_used)]
2021-08-16 11:49:12 +02:00
#![forbid(unsafe_code)]
2019-10-27 12:06:09 +01:00
2021-08-18 15:12:50 +02:00
// the toolkit to make your own
pub mod error;
2021-08-16 11:49:12 +02:00
pub mod event;
2021-08-16 15:15:17 +02:00
pub mod fs;
2021-08-16 17:09:22 +02:00
pub mod shell;
2021-08-17 11:41:13 +02:00
pub mod signal;
2021-08-16 17:09:22 +02:00
2021-08-18 15:12:50 +02:00
// the core experience
mod config;
mod watchexec;
#[doc(inline)]
pub use config::Config;
#[doc(inline)]
pub use watchexec::Watchexec;
2021-08-16 17:09:22 +02:00
// the *action* is debounced, not the events