Struct rustix::fs::inotify::Reader

source ·
pub struct Reader<'buf, Fd: AsFd> { /* private fields */ }
Expand description

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.

Implementations§

source§

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

source

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

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

source§

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

source

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:

source

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.

Auto Trait Implementations§

§

impl<'buf, Fd> Freeze for Reader<'buf, Fd>
where Fd: Freeze,

§

impl<'buf, Fd> RefUnwindSafe for Reader<'buf, Fd>
where Fd: RefUnwindSafe,

§

impl<'buf, Fd> Send for Reader<'buf, Fd>
where Fd: Send,

§

impl<'buf, Fd> Sync for Reader<'buf, Fd>
where Fd: Sync,

§

impl<'buf, Fd> Unpin for Reader<'buf, Fd>
where Fd: Unpin,

§

impl<'buf, Fd> !UnwindSafe for Reader<'buf, Fd>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.