Struct file_descriptors::fanotify::FanotifyFileDescriptor

pub struct FanotifyFileDescriptor(_);

Represents a fanotify instance.

fanotify requires the CAP_SYS_ADMIN capability, so is only suitable for priveleged processes or those running as root.

Methods

impl FanotifyFileDescriptor

pub fn new(
    use_precontent_class: bool,
    use_content_class: bool,
    read_or_write: FanotifyReadOrWrite,
    file_status_flags: FileStatusFlags
) -> Result<Self, CreationError>

Creates a new instance.

The Notification class is always enabled.

pub fn add_mark<'a>(
    &self,
    mark_flags: MarkFlags,
    mark_event_flags: MarkEventFlags,
    mark_path: &MarkPath<'a>
) -> Result<(), FanotifyMarkError>

Adds a mark.

pub fn remove_mark<'a>(
    &self,
    mark_flags: MarkFlags,
    mark_event_flags: MarkEventFlags,
    mark_path: &MarkPath<'a>
) -> Result<(), FanotifyMarkError>

Remove a mark.

pub fn remove_all_mount_or_non_mount_marks<'a>(
    &self,
    remove_mount: bool,
    mark_event_flags: MarkEventFlags,
    mark_path: &MarkPath<'a>
) -> Result<(), FanotifyMarkError>

Remove all.

pub fn read(
    &self,
    read_into: &mut Vec<fanotify_event_metadata>
) -> Result<usize, StructReadError>

Reads a fanotify event.

Use this only after a read-ready event notification is received (using edge-triggered events).

Returns the number of items read; adds read items starting at read_into.len() up to read_into.capacity().

pub fn write_permission(
    &self,
    responses: &[fanotify_response]
) -> Result<usize, StructWriteError>

For permission events, the application must write responses.

Returns the number of responses written.

For extremely efficient handling, the responses slice should be backed by a virtual ring buffer (mirror buffer).

Trait Implementations

impl AsRawFd for FanotifyFileDescriptor

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRawFdExt for FanotifyFileDescriptor

fn make_blocking(&self)

Make a file descriptor blocking (all file descriptors in this library are ordinarily non-blocking)

impl Debug for FanotifyFileDescriptor

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

Formats the value using the given formatter.

impl Drop for FanotifyFileDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for FanotifyFileDescriptor

impl FromRawFd for FanotifyFileDescriptor

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl Hash for FanotifyFileDescriptor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IntoRawFd for FanotifyFileDescriptor

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Ord for FanotifyFileDescriptor

fn cmp(&self, other: &FanotifyFileDescriptor) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FanotifyFileDescriptor> for FanotifyFileDescriptor

fn eq(&self, other: &FanotifyFileDescriptor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FanotifyFileDescriptor) -> bool

This method tests for !=.

impl PartialOrd<FanotifyFileDescriptor> for FanotifyFileDescriptor

fn partial_cmp(&self, other: &FanotifyFileDescriptor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FanotifyFileDescriptor) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FanotifyFileDescriptor) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FanotifyFileDescriptor) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FanotifyFileDescriptor) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for FanotifyFileDescriptor

impl StructuralPartialEq for FanotifyFileDescriptor