Struct FileMonitor

pub struct FileMonitor { /* private fields */ }

Monitors a file or directory for changes.

To obtain a GFileMonitor for a file or directory, use FileExt::monitor(), FileExt::monitor_file(), or FileExt::monitor_directory().

To get informed about changes to the file or directory you are monitoring, connect to the changed signal. The signal will be emitted in the thread-default main context (see [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()]) of the thread that the monitor was created in (though if the global default main context is blocked, this may cause notifications to be blocked even if the thread-default context is still running).

This is an Abstract Base Class, you cannot instantiate it.

Properties

cancelled

Whether the monitor has been cancelled.

Readable

rate-limit

The limit of the monitor to watch for changes, in milliseconds.

Readable | Writeable

Signals

changed

Emitted when @file has been changed.

If using FileMonitorFlags::WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), @event_type may be FileMonitorEvent::Renamed, FileMonitorEvent::MovedIn or FileMonitorEvent::MovedOut.

In all cases @file will be a child of the monitored directory. For renames, @file will be the old name and @other_file is the new name. For “moved in” events, @file is the name of the file that appeared and @other_file is the old name that it was moved from (in another directory). For “moved out” events, @file is the name of the file that used to be in this directory and @other_file is the name of the file at its new location.

It makes sense to treat FileMonitorEvent::MovedIn as equivalent to FileMonitorEvent::Created and FileMonitorEvent::MovedOut as equivalent to FileMonitorEvent::Deleted, with extra information. FileMonitorEvent::Renamed is equivalent to a delete/create pair. This is exactly how the events will be reported in the case that the FileMonitorFlags::WATCH_MOVES flag is not in use.

If using the deprecated flag FileMonitorFlags::SEND_MOVED flag and @event_type is FileMonitorEvent::Moved, @file will be set to a #GFile containing the old path, and @other_file will be set to a #GFile containing the new path.

In all the other cases, @other_file will be set to #NULL.

Implements

FileMonitorExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl FileMonitor

pub const NONE: Option<&'static FileMonitor> = None

Trait Implementations

impl Clone for FileMonitor

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileMonitor

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

Formats the value using the given formatter.

impl HasParamSpec for FileMonitor

type ParamSpec = ParamSpecObject

type SetValue = FileMonitor

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, FileMonitor>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileMonitor

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileMonitor

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for FileMonitor

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FileMonitor

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FileMonitor

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for FileMonitor

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileMonitor