module Gio::Volume

Overview

The #GVolume interface represents user-visible objects that can be mounted. Note, when porting from GnomeVFS, #GVolume is the moral equivalent of #GnomeVFSDrive.

Mounting a #GVolume instance is an asynchronous operation. For more information about asynchronous operations, see #GAsyncResult and #GTask. To mount a #GVolume, first call g_volume_mount() with (at least) the #GVolume instance, optionally a #GMountOperation object and a #GAsyncReadyCallback.

Typically, one will only want to pass nil for the #GMountOperation 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 #GAsyncResult instance will be passed to the callback. That callback should then call g_volume_mount_finish() with the #GVolume instance and the #GAsyncResult data to see if the operation was completed successfully. If an @error is present when g_volume_mount_finish() is called, then it will be filled with any error information.

Volume Identifiers # {#volume-identifier}

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 commandline). 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 g_volume_get_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

Class Method Summary

Instance Method Summary

Class Method Detail

def self.g_type : UInt64 #

Instance Method Detail

def activation_root : Gio::File? #

def can_eject : Bool #

def can_mount : Bool #

def changed_signal #

def drive : Gio::Drive? #

def eject(flags : Gio::MountUnmountFlags, cancellable : Gio::Cancellable?, callback : Gio::AsyncReadyCallback?, user_data : Pointer(Void)?) : Nil #

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

def eject_with_operation(flags : Gio::MountUnmountFlags, mount_operation : Gio::MountOperation?, cancellable : Gio::Cancellable?, callback : Gio::AsyncReadyCallback?, user_data : Pointer(Void)?) : Nil #

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

def enumerate_identifiers : Enumerable(String) #

def icon : Gio::Icon #

def identifier(kind : String) : String? #

def mount(flags : Gio::MountMountFlags, mount_operation : Gio::MountOperation?, cancellable : Gio::Cancellable?, callback : Gio::AsyncReadyCallback?, user_data : Pointer(Void)?) : Nil #

def mount : Gio::Mount? #

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

def name : String #

def removed_signal #

def should_automount : Bool #

def sort_key : String? #

def symbolic_icon : Gio::Icon #

abstract def to_unsafe #

def uuid : String? #