Struct simple_libc::inotify::Inotify

pub struct Inotify { /* fields omitted */ }

Implementations

impl Inotify

pub fn new(flags: InotifyFlags) -> Result<Self>

Construct a new inotify file descriptor with the given options.

pub fn add_watch<P: AsRef<Path>>(
    &mut self,
    path: P,
    events: Events,
    flags: WatchFlags
) -> Result<Watch>

Add a new watch (or modify an existing watch) for the given file.

pub fn extend_watch<P: AsRef<Path>>(
    &mut self,
    path: P,
    events: Events,
    flags: WatchFlags
) -> Result<Watch>

Add a new watch for the given file, or extend the watch mask if the watch already exists.

pub fn create_watch<P: AsRef<Path>>(
    &mut self,
    path: P,
    events: Events,
    flags: WatchFlags
) -> Result<Watch>

Add a new watch for the given file, failing with an error if the event already exists

pub fn rm_watch(&mut self, watch: Watch) -> Result<()>

Remove a previously added watch.

pub fn read_nowait(&mut self) -> Result<Vec<Event>>

Read a list of events from the inotify file descriptor, or return an empty vector if no events are pending.

pub fn read_wait(&mut self) -> Result<Vec<Event>>

Read a list of events from the inotify file descriptor, waiting for an event to occur if none are pending.

Note: The current implementation of this function may not read all of the events from the the inotify file descriptor. If that is necessary for whatever reason, it is recommended to immediately follow a call to read_wait() with a call to read_nowait() and combine the two resulting vectors.

Trait Implementations

impl AsRawFd for Inotify

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Inotify

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Drop for Inotify

fn drop(&mut self)

Executes the destructor for this type.