Skip to main content

tributary_fs/
lib.rs

1#![doc = include_str!("../README.md")]
2#![deny(missing_docs)]
3#![cfg_attr(docsrs, feature(doc_cfg))]
4#![cfg_attr(docsrs, allow(unused_attributes))]
5
6mod core;
7mod driver;
8mod error;
9mod event;
10mod options;
11mod os;
12mod stamped;
13mod watcher;
14
15pub use error::{
16  BuildError, CloseError, ReplaceRootError, SyncRootError, UnwatchError, WatchRootError,
17};
18pub use event::{Event, EventKind, MovedEvent};
19pub use options::WatcherOptions;
20pub use os::{Backend, BackendKind, BackendStats, ProbeStage, SourceError};
21pub use watcher::{
22  CoverOutcome, RequestOutcome, RootHandle, SkipReason, SyncAdmission, SyncRootDenied, SyncTicket,
23  Watcher,
24};
25
26pub use tributary_proto::{ChangeId, Epoch, Interest, Location, ScopeId, Segment};
27
28// Test-only surface for the real-kernel integration suites: forcing an
29// inotify instance rebuild deterministically requires lowering the reader's
30// descriptor threshold, which no production configuration exposes.
31#[cfg(all(target_os = "linux", not(miri), any(test, feature = "_integration")))]
32#[doc(hidden)]
33pub use os::linux::inotify::reader::override_rebuild_threshold_for_tests;
34
35/// A [`Watcher`] driven by the tokio runtime.
36#[cfg(feature = "tokio")]
37#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
38pub type TokioWatcher = Watcher<agnostic_lite::tokio::TokioRuntime>;
39
40/// A [`Watcher`] driven by the smol runtime.
41#[cfg(feature = "smol")]
42#[cfg_attr(docsrs, doc(cfg(feature = "smol")))]
43pub type SmolWatcher = Watcher<agnostic_lite::smol::SmolRuntime>;