Struct rustix::fs::inotify::Reader

pub struct Reader<'buf, Fd: AsFd> {
    fd: Fd,
    buf: &'buf mut [MaybeUninit<u8>],
    initialized: usize,
    offset: usize,
}

An inotify event iterator implemented with the read syscall.

See the RawDir API for more details and usage examples as this API is based on it.

Fields

fd: Fd

buf: &'buf mut [MaybeUninit<u8>]

initialized: usize

offset: usize

Implementations

impl<'buf, Fd: AsFd> Reader<'buf, Fd>

pub fn new(fd: Fd, buf: &'buf mut [MaybeUninit<u8>]) -> Self

Create a new iterator from the given file descriptor and buffer.

impl<'buf, Fd: AsFd> Reader<'buf, Fd>

pub fn next(&mut self) -> Result<InotifyEvent<'_>>

Read the next inotify event.

This is similar to [Iterator::next] except that it doesn’t return an Option, because the stream doesn’t have an ending. It always returns events or errors.

If there are no events in the buffer and none ready to be read:

• If the file descriptor was opened with inotify::CreateFlags::NONBLOCK, this will fail with Errno::AGAIN.
• Otherwise this will block until at least one event is ready or an error occurs.

pub fn is_buffer_empty(&self) -> bool

Returns true if the internal buffer is empty and will be refilled when calling next. This is useful to avoid further blocking reads.