Drive

Object Hierarchy:

Description:

[ CCode ( type_id = "g_drive_get_type ()" ) ]
public interface Drive : Object

`GDrive` represents a piece of hardware connected to the machine.

It’s generally only created for removable hardware or hardware with removable media. For example, an optical disc drive, or a USB flash drive.

`GDrive` is a container class for [iface@Gio.Volume] objects that stem from the same piece of media. As such, `GDrive` abstracts a drive with (or without) removable media and provides operations for querying whether media is available, determining whether media change is automatically detected and ejecting the media.

If the `GDrive` reports that media isn’t automatically detected, one can poll for media; typically one should not do this periodically as a poll for media operation is potentially expensive and may spin up the drive creating noise.

`GDrive` supports starting and stopping drives with authentication support for the former. This can be used to support a diverse set of use cases including connecting/disconnecting iSCSI devices, powering down external disk enclosures and starting/stopping multi-disk devices such as RAID devices. Note that the actual semantics and side-effects of starting/stopping a `GDrive` may vary according to implementation. To choose the correct verbs in e.g. a file manager, use [method@Gio.Drive.get_start_stop_type].

For [porting from GnomeVFS](migrating-gnome-vfs.html) note that there is no equivalent of `GDrive` in that API.

Namespace: GLib

Package: gio-2.0

Content:

Methods:

public abstract bool can_eject ()
Checks if a drive can be ejected.
public abstract bool can_poll_for_media ()
Checks if a drive can be polled for media changes.
public abstract bool can_start ()
Checks if a drive can be started.
public abstract bool can_start_degraded ()
Checks if a drive can be started degraded.
public abstract bool can_stop ()
Checks if a drive can be stopped.
public abstract async bool eject (MountUnmountFlags flags, Cancellable? cancellable = null) throws Error
Asynchronously ejects a drive.
public abstract async bool eject_with_operation (MountUnmountFlags flags, MountOperation? mount_operation, Cancellable? cancellable = null) throws Error
Ejects a drive.
public abstract string[] enumerate_identifiers ()
Gets the kinds of identifiers that this has.
public abstract Icon get_icon ()
Gets the icon for this.
public abstract string? get_identifier (string kind)
Gets the identifier of the given kind for this.
public abstract string get_name ()
Gets the name of this.
public virtual unowned string? get_sort_key ()
Gets the sort key for this, if any.
public abstract DriveStartStopType get_start_stop_type ()
Gets a hint about how a drive can be started/stopped.
public abstract Icon get_symbolic_icon ()
Gets the icon for this.
public abstract List<Volume> get_volumes ()
Get a list of mountable volumes for this .
public abstract bool has_media ()
Checks if the this has media.
public abstract bool has_volumes ()
Check if this has any mountable volumes.
public abstract bool is_media_check_automatic ()
Checks if this is capable of automatically detecting media changes.
public abstract bool is_media_removable ()
Checks if the this supports removable media.
public abstract bool is_removable ()
Checks if the Drive and/or its media is considered removable by the user.
public abstract async bool poll_for_media (Cancellable? cancellable = null) throws Error
Asynchronously polls this to see if media has been inserted or removed.
public abstract async bool start (DriveStartFlags flags, MountOperation? mount_operation, Cancellable? cancellable = null) throws Error
Asynchronously starts a drive.
public abstract async bool stop (MountUnmountFlags flags, MountOperation? mount_operation, Cancellable? cancellable = null) throws Error
Asynchronously stops a drive.

Signals:

public virtual signal void changed ()
Emitted when the drive's state has changed.
public virtual signal void disconnected ()
This signal is emitted when the Drive have been disconnected.
public virtual signal void eject_button ()
Emitted when the physical eject button (if any) of a drive has been pressed.
public virtual signal void stop_button ()
Emitted when the physical stop button (if any) of a drive has been pressed.

Inherited Members:

All known members inherited from class GLib.Object