gio/auto/

file_monitor.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, File, FileMonitorEvent};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Monitors a file or directory for changes.
    ///
    /// To obtain a `GFileMonitor` for a file or directory, use
    /// [`FileExt::monitor()`][crate::prelude::FileExt::monitor()], [`FileExt::monitor_file()`][crate::prelude::FileExt::monitor_file()], or
    /// [`FileExt::monitor_directory()`][crate::prelude::FileExt::monitor_directory()].
    ///
    /// To get informed about changes to the file or directory you are
    /// monitoring, connect to the [`changed`][struct@crate::FileMonitor#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`][crate::FileMonitorFlags::WATCH_MOVES] on a directory monitor, and
    /// the information is available (and if supported by the backend),
    /// @event_type may be [`FileMonitorEvent::Renamed`][crate::FileMonitorEvent::Renamed],
    /// [`FileMonitorEvent::MovedIn`][crate::FileMonitorEvent::MovedIn] or [`FileMonitorEvent::MovedOut`][crate::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`][crate::FileMonitorEvent::MovedIn] as
    /// equivalent to [`FileMonitorEvent::Created`][crate::FileMonitorEvent::Created] and
    /// [`FileMonitorEvent::MovedOut`][crate::FileMonitorEvent::MovedOut] as equivalent to
    /// [`FileMonitorEvent::Deleted`][crate::FileMonitorEvent::Deleted], with extra information.
    /// [`FileMonitorEvent::Renamed`][crate::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`][crate::FileMonitorFlags::WATCH_MOVES] flag is not in use.
    ///
    /// If using the deprecated flag [`FileMonitorFlags::SEND_MOVED`][crate::FileMonitorFlags::SEND_MOVED] flag and @event_type is
    /// [`FileMonitorEvent::Moved`][crate::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@crate::prelude::FileMonitorExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GFileMonitor")]
    pub struct FileMonitor(Object<ffi::GFileMonitor, ffi::GFileMonitorClass>);

    match fn {
        type_ => || ffi::g_file_monitor_get_type(),
    }
}

impl FileMonitor {
    pub const NONE: Option<&'static FileMonitor> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::FileMonitor>> Sealed for T {}
}

/// Trait containing all [`struct@FileMonitor`] methods.
///
/// # Implementors
///
/// [`FileMonitor`][struct@crate::FileMonitor]
pub trait FileMonitorExt: IsA<FileMonitor> + sealed::Sealed + 'static {
    /// Cancels a file monitor.
    ///
    /// # Returns
    ///
    /// always [`true`]
    #[doc(alias = "g_file_monitor_cancel")]
    fn cancel(&self) -> bool {
        unsafe { from_glib(ffi::g_file_monitor_cancel(self.as_ref().to_glib_none().0)) }
    }

    /// Emits the #GFileMonitor::changed signal if a change
    /// has taken place. Should be called from file monitor
    /// implementations only.
    ///
    /// Implementations are responsible to call this method from the
    /// [thread-default main context][g-main-context-push-thread-default] of the
    /// thread that the monitor was created in.
    /// ## `child`
    /// a #GFile.
    /// ## `other_file`
    /// a #GFile.
    /// ## `event_type`
    /// a set of #GFileMonitorEvent flags.
    #[doc(alias = "g_file_monitor_emit_event")]
    fn emit_event(
        &self,
        child: &impl IsA<File>,
        other_file: &impl IsA<File>,
        event_type: FileMonitorEvent,
    ) {
        unsafe {
            ffi::g_file_monitor_emit_event(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                other_file.as_ref().to_glib_none().0,
                event_type.into_glib(),
            );
        }
    }

    /// Returns whether the monitor is canceled.
    ///
    /// # Returns
    ///
    /// [`true`] if monitor is canceled. [`false`] otherwise.
    #[doc(alias = "g_file_monitor_is_cancelled")]
    #[doc(alias = "cancelled")]
    fn is_cancelled(&self) -> bool {
        unsafe {
            from_glib(ffi::g_file_monitor_is_cancelled(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the rate limit to which the @self will report
    /// consecutive change events to the same file.
    /// ## `limit_msecs`
    /// a non-negative integer with the limit in milliseconds
    ///     to poll for changes
    #[doc(alias = "g_file_monitor_set_rate_limit")]
    #[doc(alias = "rate-limit")]
    fn set_rate_limit(&self, limit_msecs: i32) {
        unsafe {
            ffi::g_file_monitor_set_rate_limit(self.as_ref().to_glib_none().0, limit_msecs);
        }
    }

    /// The limit of the monitor to watch for changes, in milliseconds.
    #[doc(alias = "rate-limit")]
    fn rate_limit(&self) -> i32 {
        ObjectExt::property(self.as_ref(), "rate-limit")
    }

    /// Emitted when @file has been changed.
    ///
    /// If using [`FileMonitorFlags::WATCH_MOVES`][crate::FileMonitorFlags::WATCH_MOVES] on a directory monitor, and
    /// the information is available (and if supported by the backend),
    /// @event_type may be [`FileMonitorEvent::Renamed`][crate::FileMonitorEvent::Renamed],
    /// [`FileMonitorEvent::MovedIn`][crate::FileMonitorEvent::MovedIn] or [`FileMonitorEvent::MovedOut`][crate::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`][crate::FileMonitorEvent::MovedIn] as
    /// equivalent to [`FileMonitorEvent::Created`][crate::FileMonitorEvent::Created] and
    /// [`FileMonitorEvent::MovedOut`][crate::FileMonitorEvent::MovedOut] as equivalent to
    /// [`FileMonitorEvent::Deleted`][crate::FileMonitorEvent::Deleted], with extra information.
    /// [`FileMonitorEvent::Renamed`][crate::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`][crate::FileMonitorFlags::WATCH_MOVES] flag is not in use.
    ///
    /// If using the deprecated flag [`FileMonitorFlags::SEND_MOVED`][crate::FileMonitorFlags::SEND_MOVED] flag and @event_type is
    /// [`FileMonitorEvent::Moved`][crate::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.
    /// ## `file`
    /// a #GFile.
    /// ## `other_file`
    /// a #GFile or #NULL.
    /// ## `event_type`
    /// a #GFileMonitorEvent.
    #[doc(alias = "changed")]
    fn connect_changed<F: Fn(&Self, &File, Option<&File>, FileMonitorEvent) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<
            P: IsA<FileMonitor>,
            F: Fn(&P, &File, Option<&File>, FileMonitorEvent) + 'static,
        >(
            this: *mut ffi::GFileMonitor,
            file: *mut ffi::GFile,
            other_file: *mut ffi::GFile,
            event_type: ffi::GFileMonitorEvent,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                FileMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(file),
                Option::<File>::from_glib_borrow(other_file)
                    .as_ref()
                    .as_ref(),
                from_glib(event_type),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"changed\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "cancelled")]
    fn connect_cancelled_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_cancelled_trampoline<
            P: IsA<FileMonitor>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GFileMonitor,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(FileMonitor::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::cancelled\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_cancelled_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "rate-limit")]
    fn connect_rate_limit_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_rate_limit_trampoline<
            P: IsA<FileMonitor>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GFileMonitor,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(FileMonitor::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::rate-limit\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_rate_limit_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<FileMonitor>> FileMonitorExt for O {}