gio_unix/auto/

mount_entry.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;
use glib::translate::*;

glib::wrapper! {
    /// Defines a Unix mount entry (e.g. `/media/cdrom`).
    /// This corresponds roughly to a mtab entry.
    #[derive(Debug)]
    pub struct MountEntry(Boxed<ffi::GUnixMountEntry>);

    match fn {
        copy => |ptr| ffi::g_unix_mount_entry_copy(ptr),
        free => |ptr| ffi::g_unix_mount_entry_free(ptr),
        type_ => || ffi::g_unix_mount_entry_get_type(),
    }
}

impl MountEntry {
    #[doc(alias = "g_unix_mount_entry_compare")]
    fn compare(&self, mount2: &MountEntry) -> i32 {
        unsafe {
            ffi::g_unix_mount_entry_compare(
                mut_override(self.to_glib_none().0),
                mut_override(mount2.to_glib_none().0),
            )
        }
    }

    /// Gets the device path for a Unix mount.
    ///
    /// # Returns
    ///
    /// a string containing the device path
    #[doc(alias = "g_unix_mount_entry_get_device_path")]
    #[doc(alias = "get_device_path")]
    pub fn device_path(&self) -> std::path::PathBuf {
        unsafe {
            from_glib_none(ffi::g_unix_mount_entry_get_device_path(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets the filesystem type for the Unix mount.
    ///
    /// # Returns
    ///
    /// a string containing the file system type
    #[doc(alias = "g_unix_mount_entry_get_fs_type")]
    #[doc(alias = "get_fs_type")]
    pub fn fs_type(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::g_unix_mount_entry_get_fs_type(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets the mount path for a Unix mount.
    ///
    /// # Returns
    ///
    /// the mount path for @self
    #[doc(alias = "g_unix_mount_entry_get_mount_path")]
    #[doc(alias = "get_mount_path")]
    pub fn mount_path(&self) -> std::path::PathBuf {
        unsafe {
            from_glib_none(ffi::g_unix_mount_entry_get_mount_path(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets a comma separated list of mount options for the Unix mount.
    ///
    /// For example: `rw,relatime,seclabel,data=ordered`.
    ///
    /// This is similar to [`MountPoint::options()`][crate::MountPoint::options()], but it takes
    /// a [`MountEntry`][crate::MountEntry] as an argument.
    ///
    /// # Returns
    ///
    /// a string containing the options, or `NULL` if not
    ///    available.
    #[doc(alias = "g_unix_mount_entry_get_options")]
    #[doc(alias = "get_options")]
    pub fn options(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::g_unix_mount_entry_get_options(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets the root of the mount within the filesystem. This is useful e.g. for
    /// mounts created by bind operation, or btrfs subvolumes.
    ///
    /// For example, the root path is equal to `/` for a mount created by
    /// `mount /dev/sda1 /mnt/foo` and `/bar` for
    /// `mount --bind /mnt/foo/bar /mnt/bar`.
    ///
    /// # Returns
    ///
    /// a string containing the root, or `NULL` if not supported
    #[doc(alias = "g_unix_mount_entry_get_root_path")]
    #[doc(alias = "get_root_path")]
    pub fn root_path(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::g_unix_mount_entry_get_root_path(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Guesses whether a Unix mount entry can be ejected.
    ///
    /// # Returns
    ///
    /// true if @self is deemed to be ejectable; false otherwise
    #[doc(alias = "g_unix_mount_entry_guess_can_eject")]
    pub fn guess_can_eject(&self) -> bool {
        unsafe {
            from_glib(ffi::g_unix_mount_entry_guess_can_eject(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Guesses the icon of a Unix mount entry.
    ///
    /// # Returns
    ///
    /// a [`gio::Icon`][crate::gio::Icon]
    #[doc(alias = "g_unix_mount_entry_guess_icon")]
    pub fn guess_icon(&self) -> gio::Icon {
        unsafe {
            from_glib_full(ffi::g_unix_mount_entry_guess_icon(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Guesses the name of a Unix mount entry.
    ///
    /// The result is a translated string.
    ///
    /// # Returns
    ///
    /// a newly allocated translated string
    #[doc(alias = "g_unix_mount_entry_guess_name")]
    pub fn guess_name(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::g_unix_mount_entry_guess_name(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Guesses whether a Unix mount entry should be displayed in the UI.
    ///
    /// # Returns
    ///
    /// true if @self is deemed to be displayable; false otherwise
    #[doc(alias = "g_unix_mount_entry_guess_should_display")]
    pub fn guess_should_display(&self) -> bool {
        unsafe {
            from_glib(ffi::g_unix_mount_entry_guess_should_display(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Guesses the symbolic icon of a Unix mount entry.
    ///
    /// # Returns
    ///
    /// a [`gio::Icon`][crate::gio::Icon]
    #[doc(alias = "g_unix_mount_entry_guess_symbolic_icon")]
    pub fn guess_symbolic_icon(&self) -> gio::Icon {
        unsafe {
            from_glib_full(ffi::g_unix_mount_entry_guess_symbolic_icon(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Checks if a Unix mount is mounted read only.
    ///
    /// # Returns
    ///
    /// true if @self is read only; false otherwise
    #[doc(alias = "g_unix_mount_entry_is_readonly")]
    pub fn is_readonly(&self) -> bool {
        unsafe {
            from_glib(ffi::g_unix_mount_entry_is_readonly(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Checks if a Unix mount is a system mount.
    ///
    /// This is the Boolean OR of
    /// [`is_system_fs_type()`][crate::is_system_fs_type()], [`is_system_device_path()`][crate::is_system_device_path()] and
    /// [`is_mount_path_system_internal()`][crate::is_mount_path_system_internal()] on @self’s properties.
    ///
    /// The definition of what a ‘system’ mount entry is may change over time as new
    /// file system types and device paths are ignored.
    ///
    /// # Returns
    ///
    /// true if the Unix mount is for a system path; false otherwise
    #[doc(alias = "g_unix_mount_entry_is_system_internal")]
    pub fn is_system_internal(&self) -> bool {
        unsafe {
            from_glib(ffi::g_unix_mount_entry_is_system_internal(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets a [`MountEntry`][crate::MountEntry] for a given mount path.
    ///
    /// If @time_read is set, it will be filled with a Unix timestamp for checking
    /// if the mounts have changed since with
    /// [`mount_entries_changed_since()`][crate::mount_entries_changed_since()].
    ///
    /// If more mounts have the same mount path, the last matching mount
    /// is returned.
    ///
    /// This will return `NULL` if there is no mount point at @mount_path.
    /// ## `mount_path`
    /// path for a possible Unix mount
    ///
    /// # Returns
    ///
    /// a [`MountEntry`][crate::MountEntry]
    ///
    /// ## `time_read`
    /// return location for a timestamp
    #[doc(alias = "g_unix_mount_entry_at")]
    #[doc(alias = "at")]
    pub fn for_mount_path(mount_path: impl AsRef<std::path::Path>) -> (Option<MountEntry>, u64) {
        unsafe {
            let mut time_read = std::mem::MaybeUninit::uninit();
            let ret = from_glib_full(ffi::g_unix_mount_entry_at(
                mount_path.as_ref().to_glib_none().0,
                time_read.as_mut_ptr(),
            ));
            (ret, time_read.assume_init())
        }
    }

    /// Gets a [`MountEntry`][crate::MountEntry] for a given file path.
    ///
    /// If @time_read is set, it will be filled with a Unix timestamp for checking
    /// if the mounts have changed since with
    /// [`mount_entries_changed_since()`][crate::mount_entries_changed_since()].
    ///
    /// If more mounts have the same mount path, the last matching mount
    /// is returned.
    ///
    /// This will return `NULL` if looking up the mount entry fails, if
    /// @file_path doesn’t exist or there is an I/O error.
    /// ## `file_path`
    /// file path on some Unix mount
    ///
    /// # Returns
    ///
    /// a [`MountEntry`][crate::MountEntry]
    ///
    /// ## `time_read`
    /// return location for a timestamp
    #[doc(alias = "g_unix_mount_entry_for")]
    #[doc(alias = "for")]
    pub fn for_file_path(file_path: impl AsRef<std::path::Path>) -> (Option<MountEntry>, u64) {
        unsafe {
            let mut time_read = std::mem::MaybeUninit::uninit();
            let ret = from_glib_full(ffi::g_unix_mount_entry_for(
                file_path.as_ref().to_glib_none().0,
                time_read.as_mut_ptr(),
            ));
            (ret, time_read.assume_init())
        }
    }
}

impl PartialEq for MountEntry {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.compare(other) == 0
    }
}

impl Eq for MountEntry {}

impl PartialOrd for MountEntry {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for MountEntry {
    #[inline]
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.compare(other).cmp(&0)
    }
}

unsafe impl Send for MountEntry {}
unsafe impl Sync for MountEntry {}