zng 0.22.0

Cross-platform GUI framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

#![cfg(feature = "fs_watcher")]

//! File system watcher service and other types.
//!
//! The [`WATCHER`] service can be used to get notifications when a file or directory is modified. It also provides
//! ways to bind a file to a variable, automatically synchronizing both.
//!
//! The example below binds the current content of a text file to at text variable using [`WATCHER.read`](WATCHER::read).
//! Any external change made to the text file updates the UI text.
//!
//! ```
//! use zng::{fs_watcher::WATCHER, prelude::*};
//!
//! # fn main() { }
//! # fn demo() {
//! # let _ =
//! Text!(WATCHER.read("dump.log", Txt::from(""), |f| f.ok()?.text().ok()))
//! # ; }
//! ```
//!
//! The next example created a read-write binding with the text file, any external change made to the text file updates the
//! `TextInput!` and any change made using the `TextInput!` updates the file contents.
//!
//! ```
//! use zng::{fs_watcher::WATCHER, prelude::*};
//!
//! # fn main() { }
//! # fn demo() {
//! # let _ =
//! TextInput!(zng::fs_watcher::WATCHER.sync(
//!     "dump.log",
//!     // initial value
//!     Txt::from(""),
//!     // read, only updates txt if returns Some
//!     |f| f.ok()?.text().ok(),
//!     // write, only change file if commit called.
//!     |txt, f| {
//!         if let Ok(mut f) = f {
//!             if f.write_text(&txt).is_ok() {
//!                 // replace actual file with temp that was successfully written.
//!                 let _ = f.commit();
//!             } else {
//!                 f.cancel();
//!             }
//!         }
//!     },
//! ))
//! # ; }
//! ```
//!
//! The [`WATCHER`] service abstracts away most of the headache of interacting with the file system. This service
//! is used internally by the implementations of [`CONFIG`] and [`L10N`].
//!
//! [`CONFIG`]: crate::config::CONFIG
//! [`L10N`]: crate::l10n::L10N
//!
//! # Full API
//!
//! See [`zng_ext_fs_watcher`] for the full watcher API.

pub use zng_ext_fs_watcher::{
    FS_CHANGES_EVENT, FsChange, FsChangeNote, FsChangeNoteHandle, FsChangesArgs, WATCHER, WatchFile, WatcherHandle, WatcherReadStatus,
    WatcherSyncStatus, WriteFile, fs_event,
};

#[cfg(feature = "image")]
mod images_ext {
    use std::path::PathBuf;

    use zng_app::hn;
    use zng_ext_fs_watcher::WATCHER;
    use zng_ext_image::*;

    /// File watcher extensions for [`IMAGES`] service.
    #[expect(non_camel_case_types)]
    pub trait IMAGES_Ext {
        /// Like [`IMAGES.read`] with automatic reload when the file at `path` is modified.
        ///
        /// [`IMAGES.read`]: IMAGES::read
        fn watch(&self, path: impl Into<PathBuf>) -> ImageVar;

        /// Like [`IMAGES.image`] with automatic cache reload when the file at `path` is modified.
        ///
        /// [`IMAGES.image`]: IMAGES::image
        fn watch_image(&self, path: impl Into<PathBuf>, options: ImageOptions, limits: Option<ImageLimits>) -> ImageVar;
    }
    impl IMAGES_Ext for IMAGES {
        fn watch(&self, path: impl Into<PathBuf>) -> ImageVar {
            watch(path.into())
        }

        fn watch_image(&self, path: impl Into<PathBuf>, options: ImageOptions, limits: Option<ImageLimits>) -> ImageVar {
            watch_image(path.into(), options, limits)
        }
    }

    fn watch(path: PathBuf) -> ImageVar {
        let img = IMAGES.read(path.clone());
        let handle = WATCHER.on_file_changed(
            path.clone(),
            true,
            hn!(|_| {
                let mut opt = ImageOptions::cache();
                opt.cache_mode = ImageCacheMode::Reload;
                let _ = IMAGES.image(path.clone(), opt, None);
            }),
        );
        img.hold(handle).perm();
        img
    }

    fn watch_image(path: PathBuf, option: ImageOptions, limits: Option<ImageLimits>) -> ImageVar {
        let img = IMAGES.image(ImageSource::Read(path.clone()), option.clone(), limits.clone());
        let handle = WATCHER.on_file_changed(
            path.clone(),
            true,
            hn!(|_| {
                let mut opt = option.clone();
                opt.cache_mode = ImageCacheMode::Reload;
                let _ = IMAGES.image(ImageSource::Read(path.clone()), opt, limits.clone());
            }),
        );
        img.hold(handle).perm();
        img
    }
}
#[cfg(feature = "image")]
pub use images_ext::*;