watchexec/crates/events

watchexec-events

Watchexec's event types.

• API documentation.
• Licensed under Apache 2.0 or MIT.
• Status: maintained.

This is particularly useful if you're building a tool that runs under Watchexec, and want to easily read its events (with --emit-events-to=json-file and --emit-events-to=json-stdin).

use std::io::{stdin, Result};
use watchexec_events::Event;

fn main() -> Result<()> {
    for line in stdin().lines() {
        let event: Event = serde_json::from_str(&line?)?;
        dbg!(event);
    }

    Ok(())
}

Features

• serde: enables serde support.
• notify: use Notify's file event types (default).

If you disable notify, you'll get a leaner dependency tree that's still able to parse the entire events, but isn't type compatible with Notify. In most deserialisation usecases, this is fine, but it's not the default to avoid surprises.