Struct dir_meta::FsWatcher

source ·

pub struct FsWatcher { /* private fields */ }

Expand description

This directory inherits most types from inotify crate Create a watcher for a certain path that can be a file or directory

Structure

use dir_meta::FsSender;
use std::path::PathBuf;

#[derive(Debug)]
pub struct FsWatcher {
    path: Option<PathBuf>,
    sender: FsSender,
}

Example

use dir_meta::{inotify::WatchMask, smol::channel, FsWatcher, WatcherOutcome};

smol::block_on(async {
    let (sender, receiver) = channel::unbounded::<WatcherOutcome>();

    let watch_options =
        WatchMask::MODIFY | WatchMask::CREATE | WatchMask::DELETE | WatchMask::DELETE_SELF;

    smol::spawn(FsWatcher::new(sender).path("Foo").watch(watch_options)).detach();

    while let Ok(data) = receiver.recv().await {
        dbg!(data);
    }
});

Implementations§

source §

impl FsWatcher

source

pub fn new(sender: FsSender) -> Self

Create a new FsWatcher by passing an async-channel::channel::Sender with type specified by FsSender

Examples found in repository ?

examples/watch_path.rs (line 11)

fn main() {
    smol::block_on(async {
        let (sender, receiver) = channel::unbounded::<WatcherOutcome>();

        let watch_options =
            WatchMask::MODIFY | WatchMask::CREATE | WatchMask::DELETE | WatchMask::DELETE_SELF;

        smol::spawn(async move {
            FsWatcher::new(sender)
                .path("Foo")
                .watch(watch_options)
                .await
                .unwrap();
        })
        .detach();

        while let Ok(data) = receiver.recv().await {
            dbg!(data);
        }
    });
}

source

pub fn path(self, path: impl AsRef<Path>) -> Self

Add the path to listen to

Examples found in repository ?

examples/watch_path.rs (line 12)

fn main() {
    smol::block_on(async {
        let (sender, receiver) = channel::unbounded::<WatcherOutcome>();

        let watch_options =
            WatchMask::MODIFY | WatchMask::CREATE | WatchMask::DELETE | WatchMask::DELETE_SELF;

        smol::spawn(async move {
            FsWatcher::new(sender)
                .path("Foo")
                .watch(watch_options)
                .await
                .unwrap();
        })
        .detach();

        while let Ok(data) = receiver.recv().await {
            dbg!(data);
        }
    });
}

source

pub async fn watch(self, watch_for: WatchMask) -> Result<()>

Watch the path using the parameters from inotify::WatchMask which can be concatenated WatchMask::MODIFY | WatchMask::CREATE | WatchMask::DELETE

Examples found in repository ?

examples/watch_path.rs (line 13)

fn main() {
    smol::block_on(async {
        let (sender, receiver) = channel::unbounded::<WatcherOutcome>();

        let watch_options =
            WatchMask::MODIFY | WatchMask::CREATE | WatchMask::DELETE | WatchMask::DELETE_SELF;

        smol::spawn(async move {
            FsWatcher::new(sender)
                .path("Foo")
                .watch(watch_options)
                .await
                .unwrap();
        })
        .detach();

        while let Ok(data) = receiver.recv().await {
            dbg!(data);
        }
    });
}