module Gio::Volume

Overview

The GVolume interface represents user-visible objects that can be mounted. For example, a file system partition on a USB flash drive, or an optical disc inserted into a disc drive.

If a GVolume is currently mounted, the corresponding Gio::Mount can be retrieved using Gio::Volume#mount.

Mounting a GVolume instance is an asynchronous operation. For more information about asynchronous operations, see Gio::AsyncResult and Gio::Task. To mount a GVolume, first call Gio::Volume#mount with (at least) the GVolume instance, optionally a Gio::MountOperation object and a Gio::AsyncReadyCallback.

Typically, one will only want to pass NULL for the Gio::MountOperation if automounting all volumes when a desktop session starts since it’s not desirable to put up a lot of dialogs asking for credentials.

The callback will be fired when the operation has resolved (either with success or failure), and a Gio::AsyncResult instance will be passed to the callback. That callback should then call Gio::Volume#mount_finish with the GVolume instance and the Gio::AsyncResult data to see if the operation was completed successfully. If a GLib::Error is present when Gio::Volume#mount_finish is called, then it will be filled with any error information.

Note, when porting from GnomeVFS, GVolume is the moral equivalent of GnomeVFSDrive.

Volume Identifiers

It is sometimes necessary to directly access the underlying operating system object behind a volume (e.g. for passing a volume to an application via the command line). For this purpose, GIO allows to obtain an ‘identifier’ for the volume. There can be different kinds of identifiers, such as Hal UDIs, filesystem labels, traditional Unix devices (e.g. /dev/sda2), UUIDs. GIO uses predefined strings as names for the different kinds of identifiers: G_VOLUME_IDENTIFIER_KIND_UUID, G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use Gio::Volume#identifier to obtain an identifier for a volume.

Note that G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available when the GVFS hal volume monitor is in use. Other volume monitors will generally be able to provide the G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE identifier, which can be used to obtain a hal device by means of libhal_manager_find_device_string_match().

Defined in:

lib/gi-crystal/src/auto/gio-2.0/volume.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.cast(obj : GObject::Object) : self #

Cast a GObject::Object to self, throws a TypeCastError if the cast can't be made.


Class Method Detail

def self.cast?(obj : GObject::Object) : self | Nil #

def self.g_type : UInt64 #

Instance Method Detail

def activation_root : Gio::File | Nil #

def can_eject : Bool #

def can_mount : Bool #

def changed_signal #

def drive : Gio::Drive | Nil #

def eject(flags : Gio::MountUnmountFlags, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

DEPRECATED


def eject_finish(result : Gio::AsyncResult) : Bool #

DEPRECATED


def eject_with_operation(flags : Gio::MountUnmountFlags, mount_operation : Gio::MountOperation | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

def eject_with_operation_finish(result : Gio::AsyncResult) : Bool #

def enumerate_identifiers : Enumerable(String) #

def icon : Gio::Icon #

def identifier(kind : String) : String | Nil #

def mount : Gio::Mount | Nil #

def mount(flags : Gio::MountMountFlags, mount_operation : Gio::MountOperation | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

def mount_finish(result : Gio::AsyncResult) : Bool #

def name : String #

def removed_signal #

def should_automount : Bool #

def sort_key : String | Nil #

def symbolic_icon : Gio::Icon #

abstract def to_unsafe #

def uuid : String | Nil #