gio.volume

Module for Volume interface

Types 2

interfaceVolume

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

Mounting a gio.volume.Volume instance is an asynchronous operation. For more information about asynchronous operations, see gio.async_result.AsyncResult and gio.task.Task. To mount a gio.volume.Volume, first call gio.volume.Volume.mount with (at least) the gio.volume.Volume instance, optionally a gio.mount_operation.MountOperation object and a gio.types.AsyncReadyCallback.

Typically, one will only want to pass NULL for the gio.mount_operation.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.async_result.AsyncResult instance will be passed to the callback. That callback should then call gio.volume.Volume.mountFinish with the gio.volume.Volume instance and the gio.async_result.AsyncResult data to see if the operation was completed successfully. If a glib.error.ErrorWrap is present when gio.volume.Volume.mountFinish is called, then it will be filled with any error information.

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: gio.types.VOLUME_IDENTIFIER_KIND_UUID, gio.types.VOLUME_IDENTIFIER_KIND_LABEL, etc. Use gio.volume.Volume.getIdentifier to obtain an identifier for a volume.

Note that gio.types.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 gio.types.VOLUME_IDENTIFIER_KIND_UNIX_DEVICE identifier, which can be used to obtain a hal device by means of libhal_manager_find_device_string_match().

Methods

GType _getGType()

bool canEject()Checks if a volume can be ejected. Returns: true if the volume can be ejected. false otherwise

bool canMount()Checks if a volume can be mounted. Returns: true if the volume can be mounted. false otherwise

void eject(gio.types.MountUnmountFlags flags,  gio.cancellable.Cancellable cancellable =  null,  gio.types.AsyncReadyCallback callback =  null)

Ejects a volume. This is an asynchronous operation, and is finished by calling [gio.volume.Volume.ejectFinish] with the volume and #GAsyncResult returned in the callback.

bool ejectFinish(gio.async_result.AsyncResult result)Finishes ejecting a volume. If any errors occurred during the operation, error will be set to contain the errors and false will be returned.

void ejectWithOperation(gio.types.MountUnmountFlags flags,  gio.mount_operation.MountOperation mountOperation =  null,  gio.cancellable.Cancellable cancellable =  null,  gio.types.AsyncReadyCallback callback =  null)

Ejects a volume. This is an asynchronous operation, and is finished by calling [gio.volume.Volume.ejectWithOperationFinish] with the volume and #GAsyncResult data returned in the callback.

bool ejectWithOperationFinish(gio.async_result.AsyncResult result)Finishes ejecting a volume. If any errors occurred during the operation, error will be set to contain the errors and false will be returned.

string[] enumerateIdentifiers()Gets the kinds of [identifiers](#volume-identifiers) that volume has. Use [gio.volume.Volume.getIdentifier] to obtain the identifiers themselves. Returns: a null-terminated array of strings contain...

gio.file.File getActivationRoot()Gets the activation root for a #GVolume if it is known ahead of mount time. Returns null otherwise. If not null and if volume is mounted, then the result of [gio.mount.Mount.getRoot] on the #GMount...

gio.drive.Drive getDrive()Gets the drive for the volume. Returns: a #GDrive or null if volume is not associated with a drive. The returned object should be unreffed with [gobject.object.ObjectWrap.unref] when no longer needed.

gio.icon.Icon getIcon()Gets the icon for volume. Returns: a #GIcon. The returned object should be unreffed with [gobject.object.ObjectWrap.unref] when no longer needed.

string getIdentifier(string kind)Gets the identifier of the given kind for volume. See the [introduction](#volume-identifiers) for more information about volume identifiers.

gio.mount.Mount getMount()Gets the mount for the volume. Returns: a #GMount or null if volume isn't mounted. The returned object should be unreffed with [gobject.object.ObjectWrap.unref] when no longer needed.

string getName()Gets the name of volume. Returns: the name for the given volume. The returned string should be freed with [glib.global.gfree] when no longer needed.

string getSortKey()Gets the sort key for volume, if any. Returns: Sorting key for volume or null if no such key is available

gio.icon.Icon getSymbolicIcon()Gets the symbolic icon for volume. Returns: a #GIcon. The returned object should be unreffed with [gobject.object.ObjectWrap.unref] when no longer needed.

string getUuid()Gets the UUID for the volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns null if there is no UUID availab...

void mount(gio.types.MountMountFlags flags,  gio.mount_operation.MountOperation mountOperation =  null,  gio.cancellable.Cancellable cancellable =  null,  gio.types.AsyncReadyCallback callback =  null)

Mounts a volume. This is an asynchronous operation, and is finished by calling [gio.volume.Volume.mountFinish] with the volume and #GAsyncResult returned in the callback.

bool mountFinish(gio.async_result.AsyncResult result)Finishes mounting a volume. If any errors occurred during the operation, error will be set to contain the errors and false will be returned.

bool shouldAutomount()Returns whether the volume should be automatically mounted. Returns: true if the volume should be automatically mounted

gulong connectChanged(T)(T callback, Flag!"After" after = No.After)Connect to `Changed` signal.

gulong connectRemoved(T)(T callback, Flag!"After" after = No.After)Connect to `Removed` signal.

interfaceVolumeGidBuilderImpl(T)

Fluent builder implementation template for gio.volume.Volume