fyrox_core/watcher.rs
1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! Resource watcher allows you to track changed resources and "tell" resource manager to reload
22//! them.
23
24use notify::{Config, Event, RecommendedWatcher, RecursiveMode, Watcher};
25use std::{
26 path::Path,
27 sync::mpsc::{channel, Receiver},
28 time::Duration,
29};
30
31/// Resource watcher allows you to track changed resources and "tell" resource manager to reload
32/// them.
33pub struct FileSystemWatcher {
34 #[allow(dead_code)] // We must keep watcher alive, but compiler isn't smart enough.
35 watcher: RecommendedWatcher,
36 receiver: Receiver<notify::Result<Event>>,
37}
38
39impl FileSystemWatcher {
40 /// Creates new resource watcher with a path to watch and notification delay.
41 pub fn new<P: AsRef<Path>>(path: P, delay: Duration) -> Result<Self, notify::Error> {
42 let (tx, rx) = channel();
43
44 let mut watcher = RecommendedWatcher::new(tx, Config::default().with_poll_interval(delay))?;
45
46 watcher.watch(path.as_ref(), RecursiveMode::Recursive)?;
47
48 Ok(Self {
49 receiver: rx,
50 watcher,
51 })
52 }
53
54 pub fn try_get_event(&self) -> Option<Event> {
55 if let Ok(Ok(evt)) = self.receiver.try_recv() {
56 return Some(evt);
57 }
58 None
59 }
60}