Volume

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.ErrorG 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: G_VOLUME_IDENTIFIER_KIND_UUID, G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use gio.volume.Volume.getIdentifier 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().

interface Volume {

bool canEject();

bool canMount();

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

bool ejectFinish(gio.async_result.AsyncResult result);

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

bool ejectWithOperationFinish(gio.async_result.AsyncResult result);

string[] enumerateIdentifiers();

gio.file.File getActivationRoot();

gio.drive.Drive getDrive();

gio.icon.Icon getIcon();

string getIdentifier(string kind);

gio.mount.Mount getMount();

string getName();

string getSortKey();

gio.icon.Icon getSymbolicIcon();

string getUuid();

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

bool mountFinish(gio.async_result.AsyncResult result);

bool shouldAutomount();

ulong connectChanged(T callback, Flag!"After" after);

ulong connectRemoved(T callback, Flag!"After" after);

}

Members

Functions

canEject bool canEject(): Checks if a volume can be ejected.
canMount bool canMount(): Checks if a volume can be mounted.
connectChanged ulong connectChanged(T callback, Flag!"After" after): Connect to Changed signal.
connectRemoved ulong connectRemoved(T callback, Flag!"After" after): Connect to Removed signal.
eject void eject(gio.types.MountUnmountFlags flags, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): 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.
ejectFinish 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.
ejectWithOperation void ejectWithOperation(gio.types.MountUnmountFlags flags, gio.mount_operation.MountOperation mountOperation, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): 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.
ejectWithOperationFinish 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.
enumerateIdentifiers string[] enumerateIdentifiers(): Gets the kinds of identifiers that volume has. Use gio.volume.Volume.getIdentifier to obtain the identifiers themselves.
getActivationRoot 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 object obtained from gio.volume.Volume.getMount will always either be equal or a prefix of what this function returns. In other words, in code
getDrive gio.drive.Drive getDrive(): Gets the drive for the volume.
getIcon gio.icon.Icon getIcon(): Gets the icon for volume.
getIdentifier string getIdentifier(string kind): Gets the identifier of the given kind for volume. See the introduction for more information about volume identifiers.
getMount gio.mount.Mount getMount(): Gets the mount for the volume.
getName string getName(): Gets the name of volume.
getSortKey string getSortKey(): Gets the sort key for volume, if any.
getSymbolicIcon gio.icon.Icon getSymbolicIcon(): Gets the symbolic icon for volume.
getUuid 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 available.
mount void mount(gio.types.MountMountFlags flags, gio.mount_operation.MountOperation mountOperation, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): 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.
mountFinish 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.
shouldAutomount bool shouldAutomount(): Returns whether the volume should be automatically mounted.

gio volume interfaces

Volume