gio/auto/

volume_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, Drive, Mount, Volume};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// `GVolumeMonitor` is for listing the user interesting devices and volumes
    /// on the computer. In other words, what a file selector or file manager
    /// would show in a sidebar.
    ///
    /// `GVolumeMonitor` is not
    /// thread-default-context aware (see
    /// [`glib::MainContext::push_thread_default()`][crate::glib::MainContext::push_thread_default()]), and so should not be used
    /// other than from the main thread, with no thread-default-context active.
    ///
    /// In order to receive updates about volumes and mounts monitored through GVFS,
    /// a main loop must be running.
    ///
    /// ## Signals
    ///
    ///
    /// #### `drive-changed`
    ///  Emitted when a drive changes.
    ///
    ///
    ///
    ///
    /// #### `drive-connected`
    ///  Emitted when a drive is connected to the system.
    ///
    ///
    ///
    ///
    /// #### `drive-disconnected`
    ///  Emitted when a drive is disconnected from the system.
    ///
    ///
    ///
    ///
    /// #### `drive-eject-button`
    ///  Emitted when the eject button is pressed on @drive.
    ///
    ///
    ///
    ///
    /// #### `drive-stop-button`
    ///  Emitted when the stop button is pressed on @drive.
    ///
    ///
    ///
    ///
    /// #### `mount-added`
    ///  Emitted when a mount is added.
    ///
    ///
    ///
    ///
    /// #### `mount-changed`
    ///  Emitted when a mount changes.
    ///
    ///
    ///
    ///
    /// #### `mount-pre-unmount`
    ///  May be emitted when a mount is about to be removed.
    ///
    /// This signal depends on the backend and is only emitted if
    /// GIO was used to unmount.
    ///
    ///
    ///
    ///
    /// #### `mount-removed`
    ///  Emitted when a mount is removed.
    ///
    ///
    ///
    ///
    /// #### `volume-added`
    ///  Emitted when a mountable volume is added to the system.
    ///
    ///
    ///
    ///
    /// #### `volume-changed`
    ///  Emitted when mountable volume is changed.
    ///
    ///
    ///
    ///
    /// #### `volume-removed`
    ///  Emitted when a mountable volume is removed from the system.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`VolumeMonitorExt`][trait@crate::prelude::VolumeMonitorExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GVolumeMonitor")]
    pub struct VolumeMonitor(Object<ffi::GVolumeMonitor, ffi::GVolumeMonitorClass>);

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

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

    /// Gets the volume monitor used by gio.
    ///
    /// # Returns
    ///
    /// a reference to the #GVolumeMonitor used by gio. Call
    ///    g_object_unref() when done with it, after disconnecting any signal handlers.
    #[doc(alias = "g_volume_monitor_get")]
    pub fn get() -> VolumeMonitor {
        unsafe { from_glib_full(ffi::g_volume_monitor_get()) }
    }
}

/// Trait containing all [`struct@VolumeMonitor`] methods.
///
/// # Implementors
///
/// [`NativeVolumeMonitor`][struct@crate::NativeVolumeMonitor], [`VolumeMonitor`][struct@crate::VolumeMonitor]
pub trait VolumeMonitorExt: IsA<VolumeMonitor> + 'static {
    /// Gets a list of drives connected to the system.
    ///
    /// The returned list should be freed with g_list_free(), after
    /// its elements have been unreffed with g_object_unref().
    ///
    /// # Returns
    ///
    /// a #GList of connected #GDrive objects.
    #[doc(alias = "g_volume_monitor_get_connected_drives")]
    #[doc(alias = "get_connected_drives")]
    fn connected_drives(&self) -> Vec<Drive> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::g_volume_monitor_get_connected_drives(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Finds a #GMount object by its UUID (see g_mount_get_uuid())
    /// ## `uuid`
    /// the UUID to look for
    ///
    /// # Returns
    ///
    /// a #GMount or [`None`] if no such mount is available.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_volume_monitor_get_mount_for_uuid")]
    #[doc(alias = "get_mount_for_uuid")]
    fn mount_for_uuid(&self, uuid: &str) -> Option<Mount> {
        unsafe {
            from_glib_full(ffi::g_volume_monitor_get_mount_for_uuid(
                self.as_ref().to_glib_none().0,
                uuid.to_glib_none().0,
            ))
        }
    }

    /// Gets a list of the mounts on the system.
    ///
    /// The returned list should be freed with g_list_free(), after
    /// its elements have been unreffed with g_object_unref().
    ///
    /// # Returns
    ///
    /// a #GList of #GMount objects.
    #[doc(alias = "g_volume_monitor_get_mounts")]
    #[doc(alias = "get_mounts")]
    fn mounts(&self) -> Vec<Mount> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::g_volume_monitor_get_mounts(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Finds a #GVolume object by its UUID (see g_volume_get_uuid())
    /// ## `uuid`
    /// the UUID to look for
    ///
    /// # Returns
    ///
    /// a #GVolume or [`None`] if no such volume is available.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_volume_monitor_get_volume_for_uuid")]
    #[doc(alias = "get_volume_for_uuid")]
    fn volume_for_uuid(&self, uuid: &str) -> Option<Volume> {
        unsafe {
            from_glib_full(ffi::g_volume_monitor_get_volume_for_uuid(
                self.as_ref().to_glib_none().0,
                uuid.to_glib_none().0,
            ))
        }
    }

    /// Gets a list of the volumes on the system.
    ///
    /// The returned list should be freed with g_list_free(), after
    /// its elements have been unreffed with g_object_unref().
    ///
    /// # Returns
    ///
    /// a #GList of #GVolume objects.
    #[doc(alias = "g_volume_monitor_get_volumes")]
    #[doc(alias = "get_volumes")]
    fn volumes(&self) -> Vec<Volume> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::g_volume_monitor_get_volumes(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Emitted when a drive changes.
    /// ## `drive`
    /// the drive that changed
    #[doc(alias = "drive-changed")]
    fn connect_drive_changed<F: Fn(&Self, &Drive) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drive_changed_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Drive) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            drive: *mut ffi::GDrive,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(drive),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drive-changed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drive_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a drive is connected to the system.
    /// ## `drive`
    /// a #GDrive that was connected.
    #[doc(alias = "drive-connected")]
    fn connect_drive_connected<F: Fn(&Self, &Drive) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drive_connected_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Drive) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            drive: *mut ffi::GDrive,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(drive),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drive-connected".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drive_connected_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a drive is disconnected from the system.
    /// ## `drive`
    /// a #GDrive that was disconnected.
    #[doc(alias = "drive-disconnected")]
    fn connect_drive_disconnected<F: Fn(&Self, &Drive) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drive_disconnected_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Drive) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            drive: *mut ffi::GDrive,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(drive),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drive-disconnected".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drive_disconnected_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the eject button is pressed on @drive.
    /// ## `drive`
    /// the drive where the eject button was pressed
    #[doc(alias = "drive-eject-button")]
    fn connect_drive_eject_button<F: Fn(&Self, &Drive) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drive_eject_button_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Drive) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            drive: *mut ffi::GDrive,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(drive),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drive-eject-button".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drive_eject_button_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the stop button is pressed on @drive.
    /// ## `drive`
    /// the drive where the stop button was pressed
    #[doc(alias = "drive-stop-button")]
    fn connect_drive_stop_button<F: Fn(&Self, &Drive) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drive_stop_button_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Drive) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            drive: *mut ffi::GDrive,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(drive),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drive-stop-button".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drive_stop_button_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a mount is added.
    /// ## `mount`
    /// a #GMount that was added.
    #[doc(alias = "mount-added")]
    fn connect_mount_added<F: Fn(&Self, &Mount) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn mount_added_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Mount) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            mount: *mut ffi::GMount,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(mount),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"mount-added".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mount_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a mount changes.
    /// ## `mount`
    /// a #GMount that changed.
    #[doc(alias = "mount-changed")]
    fn connect_mount_changed<F: Fn(&Self, &Mount) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn mount_changed_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Mount) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            mount: *mut ffi::GMount,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(mount),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"mount-changed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mount_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// May be emitted when a mount is about to be removed.
    ///
    /// This signal depends on the backend and is only emitted if
    /// GIO was used to unmount.
    /// ## `mount`
    /// a #GMount that is being unmounted.
    #[doc(alias = "mount-pre-unmount")]
    fn connect_mount_pre_unmount<F: Fn(&Self, &Mount) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn mount_pre_unmount_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Mount) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            mount: *mut ffi::GMount,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(mount),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"mount-pre-unmount".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mount_pre_unmount_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a mount is removed.
    /// ## `mount`
    /// a #GMount that was removed.
    #[doc(alias = "mount-removed")]
    fn connect_mount_removed<F: Fn(&Self, &Mount) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn mount_removed_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Mount) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            mount: *mut ffi::GMount,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(mount),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"mount-removed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mount_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a mountable volume is added to the system.
    /// ## `volume`
    /// a #GVolume that was added.
    #[doc(alias = "volume-added")]
    fn connect_volume_added<F: Fn(&Self, &Volume) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn volume_added_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Volume) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            volume: *mut ffi::GVolume,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(volume),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"volume-added".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    volume_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when mountable volume is changed.
    /// ## `volume`
    /// a #GVolume that changed.
    #[doc(alias = "volume-changed")]
    fn connect_volume_changed<F: Fn(&Self, &Volume) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn volume_changed_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Volume) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            volume: *mut ffi::GVolume,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(volume),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"volume-changed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    volume_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a mountable volume is removed from the system.
    /// ## `volume`
    /// a #GVolume that was removed.
    #[doc(alias = "volume-removed")]
    fn connect_volume_removed<F: Fn(&Self, &Volume) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn volume_removed_trampoline<
            P: IsA<VolumeMonitor>,
            F: Fn(&P, &Volume) + 'static,
        >(
            this: *mut ffi::GVolumeMonitor,
            volume: *mut ffi::GVolume,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VolumeMonitor::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(volume),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"volume-removed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    volume_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<VolumeMonitor>> VolumeMonitorExt for O {}