Struct gio::MountOperation

pub struct MountOperation { /* private fields */ }

MountOperation provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications preventing unmount or eject operations from completing.

Note that MountOperation is used for more than just Mount objects – for example it is also used in DriveExt::start() and DriveExt::stop().

Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as GtkMountOperation. If no user interaction is desired (for example when automounting filesystems at login time), usually None can be passed, see each method taking a MountOperation for details.

The term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. TrueCrypt is a discontinued system for encrypting file containers, partitions or whole disks, typically used with Windows. VeraCrypt is a maintained fork of TrueCrypt with various improvements and auditing fixes.

Properties

anonymous

Whether to use an anonymous user when authenticating.

Readable | Writeable

choice

The index of the user’s choice when a question is asked during the mount operation. See the ask-question signal.

Readable | Writeable

domain

The domain to use for the mount operation.

Readable | Writeable

is-tcrypt-hidden-volume

Whether the device to be unlocked is a TCRYPT hidden volume. See the VeraCrypt documentation.

Readable | Writeable

is-tcrypt-system-volume

Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see the VeraCrypt documentation.

Readable | Writeable

password

The password that is used for authentication when carrying out the mount operation.

Readable | Writeable

password-save

Determines if and how the password information should be saved.

Readable | Writeable

pim

The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See the VeraCrypt documentation.

Readable | Writeable

username

The user name that is used for authentication when carrying out the mount operation.

Readable | Writeable

Signals

aborted

Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.

Implementations of GMountOperation should handle this signal by dismissing open password dialogs.

ask-password

Emitted when a mount operation asks the user for a password.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

ask-question

Emitted when asking the user a question and gives a list of choices for the user to choose from.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

reply

Emitted when the user has replied to the mount operation.

show-processes

Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a Mount or stopping a Drive.

Note that this signal may be emitted several times to update the list of blocking processes as processes close files. The application should only respond with MountOperationExt::reply() to the latest signal (setting choice to the choice the user made).

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

show-unmount-progress

Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds).

When unmounting or ejecting a volume, the kernel might need to flush pending data in its buffers to the volume stable storage, and this operation can take a considerable amount of time. This signal may be emitted several times as long as the unmount operation is outstanding, and then one last time when the operation is completed, with bytes_left set to zero.

Implementations of GMountOperation should handle this signal by showing an UI notification, and then dismiss it, or show another notification of completion, when bytes_left reaches zero.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Implements

MountOperationExt, glib::ObjectExt

Implementations

impl MountOperation

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

pub fn new() -> MountOperation

Creates a new mount operation.

Returns

a MountOperation.

Trait Implementations

impl Clone for MountOperation

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MountOperation

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

Formats the value using the given formatter.

impl Default for MountOperation

fn default() -> Self

Returns the “default value” for a type.

impl Display for MountOperation

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

Formats the value using the given formatter.

impl HasParamSpec for MountOperation

type ParamSpec = ParamSpecObject

type SetValue = MountOperation

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MountOperation

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

where H: Hasher,

Feeds this value into the given Hasher.

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 MountOperation

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for MountOperation

type Parent = Object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl StaticType for MountOperation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MountOperation