Skip to main content

FileWatcher

Struct FileWatcher 

Source
pub struct FileWatcher<M: Send + 'static> { /* private fields */ }
Expand description

A subscription that reports changes to one filesystem path.

The watcher polls the path’s metadata (modification time and size) every interval (250 ms by default) and sends one message per observed transition: FileEvent::Created, FileEvent::Modified or FileEvent::Removed. Polling keeps the runtime free of platform watcher dependencies and behaves the same everywhere; the trade-offs are latency bounded by the interval and that an edit which leaves both size and modification time unchanged within one interval is not reported (a same-length rewrite on a filesystem with coarse timestamps). Watching a directory reports changes to the directory entry itself (entries added or removed), not edits inside nested files.

§Example

ⓘ
fn subscriptions(&self) -> Vec<Box<dyn Subscription<MyMsg>>> {
    vec![file_watcher("config.toml", MyMsg::ConfigChanged)]
}

Implementations§

Source§

impl<M: Send + 'static> FileWatcher<M>

Source

pub const DEFAULT_INTERVAL: Duration

Default poll interval.

Source

pub fn new( path: impl Into<PathBuf>, make_msg: impl Fn(FileEvent) -> M + Send + Sync + 'static, ) -> Self

Watch path, turning each observed FileEvent into a message.

Source

pub fn with_interval(self, interval: Duration) -> Self

Set the poll interval (clamped to at least 1 ms).

Source

pub fn path(&self) -> &Path

The watched path.

Source

pub fn interval(&self) -> Duration

The poll interval.

Trait Implementations§

Source§

impl<M: Send + 'static> Subscription<M> for FileWatcher<M>

Source§

fn id(&self) -> SubId

Unique identifier for deduplication. Read more
Source§

fn run(&self, sender: SubscriptionSender<M>, stop: StopSignal)

Start the subscription, sending messages through the channel. Read more

Auto Trait Implementations§

§

impl<M> !RefUnwindSafe for FileWatcher<M>

§

impl<M> !UnwindSafe for FileWatcher<M>

§

impl<M> Freeze for FileWatcher<M>
where Box<dyn Fn(FileEvent) -> M + Send + Sync>: Freeze,

§

impl<M> Send for FileWatcher<M>
where Box<dyn Fn(FileEvent) -> M + Send + Sync>: Send,

§

impl<M> Sync for FileWatcher<M>
where Box<dyn Fn(FileEvent) -> M + Send + Sync>: Sync,

§

impl<M> Unpin for FileWatcher<M>
where Box<dyn Fn(FileEvent) -> M + Send + Sync>: Unpin,

§

impl<M> UnsafeUnpin for FileWatcher<M>
where Box<dyn Fn(FileEvent) -> M + Send + Sync>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more