Struct nix::sys::fanotify::Fanotify

pub struct Fanotify { /* private fields */ }

Available on crate feature fanotify only.

A fanotify group. This is also a file descriptor that can feed to other interfaces consuming file descriptors.

Implementations

impl Fanotify

pub fn init(flags: InitFlags, event_f_flags: EventFFlags) -> Result<Fanotify>

Initialize a new fanotify group.

Returns a Result containing a Fanotify instance.

For more information, see fanotify_init(2).

pub fn mark<P: ?Sized + NixPath>( &self, flags: MarkFlags, mask: MaskFlags, dirfd: Option<RawFd>, path: Option<&P> ) -> Result<()>

Add, remove, or modify an fanotify mark on a filesystem object. If dirfd is None, AT_FDCWD is used.

Returns a Result containing either () on success or errno otherwise.

For more information, see fanotify_mark(2).

pub fn read_events(&self) -> Result<Vec<FanotifyEvent>>

Read incoming events from the fanotify group.

Returns a Result containing either a Vec of events on success or errno otherwise.

Errors

Possible errors can be those that are explicitly listed in fanotify(2) in addition to the possible errors caused by read call. In particular, EAGAIN is returned when no event is available on a group that has been initialized with the flag InitFlags::FAN_NONBLOCK, thus making this method nonblocking.

pub fn write_response(&self, response: FanotifyResponse<'_>) -> Result<()>

Write an event response on the fanotify group.

Returns a Result containing either () on success or errno otherwise.

Errors

Possible errors can be those that are explicitly listed in fanotify(2) in addition to the possible errors caused by write call. In particular, EAGAIN or EWOULDBLOCK is returned when no event is available on a group that has been initialized with the flag InitFlags::FAN_NONBLOCK, thus making this method nonblocking.

Trait Implementations

impl AsFd for Fanotify

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl Debug for Fanotify

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

Formats the value using the given formatter.

impl FromRawFd for Fanotify

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.