GI.Gio.Interfaces.Drive

Drive - this represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media.

Drive is a container class for Volume objects that stem from the same piece of media. As such, Drive 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 Drive 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 potententially expensive and may spin up the drive creating noise.

Drive 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 Drive may vary according to implementation. To choose the correct verbs in e.g. a file manager, use driveGetStartStopType.

For porting from GnomeVFS note that there is no equivalent of Drive in that API.

Exported types

newtype Drive

Memory-managed wrapper type.

Constructors

Drive (ManagedPtr Drive)

Instances

Eq Drive

Defined in GI.Gio.Interfaces.Drive

Methods

(==) :: Drive -> Drive -> Bool

(/=) :: Drive -> Drive -> Bool

GObject Drive

Defined in GI.Gio.Interfaces.Drive

Methods

gobjectType :: IO GType

IsGValue Drive

Convert Drive to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Interfaces.Drive

Methods

toGValue :: Drive -> IO GValue

fromGValue :: GValue -> IO Drive

HasParentTypes Drive

Defined in GI.Gio.Interfaces.Drive

type ParentTypes Drive

Defined in GI.Gio.Interfaces.Drive

type ParentTypes Drive = '[Object]

noDrive :: Maybe Drive

A convenience alias for Nothing :: Maybe Drive.

class (GObject o, IsDescendantOf Drive o) => IsDrive o

Type class for types which can be safely cast to Drive, for instance with toDrive.

Instances

(GObject o, IsDescendantOf Drive o) => IsDrive o

Defined in GI.Gio.Interfaces.Drive

toDrive :: (MonadIO m, IsDrive o) => o -> m Drive

Cast to Drive, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

canEject

driveCanEject

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive can be ejected, False otherwise.

Checks if a drive can be ejected.

canPollForMedia

driveCanPollForMedia

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive can be polled for media changes, False otherwise.

Checks if a drive can be polled for media changes.

canStart

driveCanStart

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive can be started, False otherwise.

Checks if a drive can be started.

Since: 2.22

canStartDegraded

driveCanStartDegraded

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive can be started degraded, False otherwise.

Checks if a drive can be started degraded.

Since: 2.22

canStop

driveCanStop

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive can be stopped, False otherwise.

Checks if a drive can be stopped.

Since: 2.22

eject

driveEject

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsCancellable b)

=> a

drive: a Drive.

-> [MountUnmountFlags]

flags: flags affecting the unmount if required for eject

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback, or Nothing.

-> m ()

Deprecated: (Since version 2.22)Use driveEjectWithOperation instead.

Asynchronously ejects a drive.

When the operation is finished, callback will be called. You can then call driveEjectFinish to obtain the result of the operation.

ejectFinish

driveEjectFinish

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsAsyncResult b)

=> a

drive: a Drive.

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Deprecated: (Since version 2.22)Use driveEjectWithOperationFinish instead.

Finishes ejecting a drive.

ejectWithOperation

driveEjectWithOperation

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsMountOperation b, IsCancellable c)

=> a

drive: a Drive.

-> [MountUnmountFlags]

flags: flags affecting the unmount if required for eject

-> Maybe b

mountOperation: a MountOperation or Nothing to avoid user interaction.

-> Maybe c

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback, or Nothing.

-> m ()

Ejects a drive. This is an asynchronous operation, and is finished by calling driveEjectWithOperationFinish with the drive and AsyncResult data returned in the callback.

Since: 2.22

ejectWithOperationFinish

driveEjectWithOperationFinish

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsAsyncResult b)

=> a

drive: a Drive.

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Finishes ejecting a drive. If any errors occurred during the operation, error will be set to contain the errors and False will be returned.

Since: 2.22

enumerateIdentifiers

driveEnumerateIdentifiers

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive

-> m [Text]

Returns: a Nothing-terminated array of strings containing kinds of identifiers. Use strfreev to free.

Gets the kinds of identifiers that drive has. Use driveGetIdentifier to obtain the identifiers themselves.

getIcon

driveGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Icon

Returns: Icon for the drive. Free the returned object with objectUnref.

Gets the icon for drive.

getIdentifier

driveGetIdentifier

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive

-> Text

kind: the kind of identifier to return

-> m (Maybe Text)

Returns: a newly allocated string containing the requested identifier, or Nothing if the Drive doesn't have this kind of identifier.

Gets the identifier of the given kind for drive. The only identifier currently available is DRIVE_IDENTIFIER_KIND_UNIX_DEVICE.

getName

driveGetName

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Text

Returns: a string containing drive's name. The returned string should be freed when no longer needed.

Gets the name of drive.

getSortKey

driveGetSortKey

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: A Drive.

-> m (Maybe Text)

Returns: Sorting key for drive or Nothing if no such key is available.

Gets the sort key for drive, if any.

Since: 2.32

getStartStopType

driveGetStartStopType

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m DriveStartStopType

Returns: A value from the DriveStartStopType enumeration.

Gets a hint about how a drive can be started/stopped.

Since: 2.22

getSymbolicIcon

driveGetSymbolicIcon

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Icon

Returns: symbolic Icon for the drive. Free the returned object with objectUnref.

Gets the icon for drive.

Since: 2.34

getVolumes

driveGetVolumes

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m [Volume]

Returns: List containing any Volume objects on the given drive.

Get a list of mountable volumes for drive.

The returned list should be freed with g_list_free(), after its elements have been unreffed with objectUnref.

hasMedia

driveHasMedia

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if drive has media, False otherwise.

Checks if the drive has media. Note that the OS may not be polling the drive for media changes; see driveIsMediaCheckAutomatic for more details.

hasVolumes

driveHasVolumes

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive contains volumes, False otherwise.

Check if drive has any mountable volumes.

isMediaCheckAutomatic

driveIsMediaCheckAutomatic

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if the drive is capabable of automatically detecting media changes, False otherwise.

Checks if drive is capabable of automatically detecting media changes.

isMediaRemovable

driveIsMediaRemovable

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if drive supports removable media, False otherwise.

Checks if the drive supports removable media.

isRemovable

driveIsRemovable

Arguments

:: (HasCallStack, MonadIO m, IsDrive a)

=> a

drive: a Drive.

-> m Bool

Returns: True if drive and/or its media is considered removable, False otherwise.

Checks if the Drive and/or its media is considered removable by the user. See driveIsMediaRemovable.

Since: 2.50

pollForMedia

drivePollForMedia

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsCancellable b)

=> a

drive: a Drive.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback, or Nothing.

-> m ()

Asynchronously polls drive to see if media has been inserted or removed.

When the operation is finished, callback will be called. You can then call drivePollForMediaFinish to obtain the result of the operation.

pollForMediaFinish

drivePollForMediaFinish

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsAsyncResult b)

=> a

drive: a Drive.

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Finishes an operation started with drivePollForMedia on a drive.

start

driveStart

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsMountOperation b, IsCancellable c)

=> a

drive: a Drive.

-> [DriveStartFlags]

flags: flags affecting the start operation.

-> Maybe b

mountOperation: a MountOperation or Nothing to avoid user interaction.

-> Maybe c

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback, or Nothing.

-> m ()

Asynchronously starts a drive.

When the operation is finished, callback will be called. You can then call driveStartFinish to obtain the result of the operation.

Since: 2.22

startFinish

driveStartFinish

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsAsyncResult b)

=> a

drive: a Drive.

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Finishes starting a drive.

Since: 2.22

stop

driveStop

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsMountOperation b, IsCancellable c)

=> a

drive: a Drive.

-> [MountUnmountFlags]

flags: flags affecting the unmount if required for stopping.

-> Maybe b

mountOperation: a MountOperation or Nothing to avoid user interaction.

-> Maybe c

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback, or Nothing.

-> m ()

Asynchronously stops a drive.

When the operation is finished, callback will be called. You can then call driveStopFinish to obtain the result of the operation.

Since: 2.22

stopFinish

driveStopFinish

Arguments

:: (HasCallStack, MonadIO m, IsDrive a, IsAsyncResult b)

=> a

drive: a Drive.

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Finishes stopping a drive.

Since: 2.22

Signals

changed

type C_DriveChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DriveChangedCallback = IO ()

Emitted when the drive's state has changed.

afterDriveChanged :: (IsDrive a, MonadIO m) => a -> DriveChangedCallback -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after drive #changed callback

genClosure_DriveChanged :: MonadIO m => DriveChangedCallback -> m (GClosure C_DriveChangedCallback)

Wrap the callback into a GClosure.

mk_DriveChangedCallback :: C_DriveChangedCallback -> IO (FunPtr C_DriveChangedCallback)

Generate a function pointer callable from C code, from a C_DriveChangedCallback.

noDriveChangedCallback :: Maybe DriveChangedCallback

A convenience synonym for Nothing :: Maybe DriveChangedCallback.

onDriveChanged :: (IsDrive a, MonadIO m) => a -> DriveChangedCallback -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on drive #changed callback

wrap_DriveChangedCallback :: DriveChangedCallback -> C_DriveChangedCallback

Wrap a DriveChangedCallback into a C_DriveChangedCallback.

disconnected

type C_DriveDisconnectedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DriveDisconnectedCallback = IO ()

This signal is emitted when the Drive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.

afterDriveDisconnected :: (IsDrive a, MonadIO m) => a -> DriveDisconnectedCallback -> m SignalHandlerId

Connect a signal handler for the disconnected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after drive #disconnected callback

genClosure_DriveDisconnected :: MonadIO m => DriveDisconnectedCallback -> m (GClosure C_DriveDisconnectedCallback)

Wrap the callback into a GClosure.

mk_DriveDisconnectedCallback :: C_DriveDisconnectedCallback -> IO (FunPtr C_DriveDisconnectedCallback)

Generate a function pointer callable from C code, from a C_DriveDisconnectedCallback.

noDriveDisconnectedCallback :: Maybe DriveDisconnectedCallback

A convenience synonym for Nothing :: Maybe DriveDisconnectedCallback.

onDriveDisconnected :: (IsDrive a, MonadIO m) => a -> DriveDisconnectedCallback -> m SignalHandlerId

Connect a signal handler for the disconnected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on drive #disconnected callback

wrap_DriveDisconnectedCallback :: DriveDisconnectedCallback -> C_DriveDisconnectedCallback

Wrap a DriveDisconnectedCallback into a C_DriveDisconnectedCallback.

ejectButton

type C_DriveEjectButtonCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DriveEjectButtonCallback = IO ()

Emitted when the physical eject button (if any) of a drive has been pressed.

afterDriveEjectButton :: (IsDrive a, MonadIO m) => a -> DriveEjectButtonCallback -> m SignalHandlerId

Connect a signal handler for the ejectButton signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after drive #ejectButton callback

genClosure_DriveEjectButton :: MonadIO m => DriveEjectButtonCallback -> m (GClosure C_DriveEjectButtonCallback)

Wrap the callback into a GClosure.

mk_DriveEjectButtonCallback :: C_DriveEjectButtonCallback -> IO (FunPtr C_DriveEjectButtonCallback)

Generate a function pointer callable from C code, from a C_DriveEjectButtonCallback.

noDriveEjectButtonCallback :: Maybe DriveEjectButtonCallback

A convenience synonym for Nothing :: Maybe DriveEjectButtonCallback.

onDriveEjectButton :: (IsDrive a, MonadIO m) => a -> DriveEjectButtonCallback -> m SignalHandlerId

Connect a signal handler for the ejectButton signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on drive #ejectButton callback

wrap_DriveEjectButtonCallback :: DriveEjectButtonCallback -> C_DriveEjectButtonCallback

Wrap a DriveEjectButtonCallback into a C_DriveEjectButtonCallback.

stopButton

type C_DriveStopButtonCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DriveStopButtonCallback = IO ()

Emitted when the physical stop button (if any) of a drive has been pressed.

Since: 2.22

afterDriveStopButton :: (IsDrive a, MonadIO m) => a -> DriveStopButtonCallback -> m SignalHandlerId

Connect a signal handler for the stopButton signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after drive #stopButton callback

genClosure_DriveStopButton :: MonadIO m => DriveStopButtonCallback -> m (GClosure C_DriveStopButtonCallback)

Wrap the callback into a GClosure.

mk_DriveStopButtonCallback :: C_DriveStopButtonCallback -> IO (FunPtr C_DriveStopButtonCallback)

Generate a function pointer callable from C code, from a C_DriveStopButtonCallback.

noDriveStopButtonCallback :: Maybe DriveStopButtonCallback

A convenience synonym for Nothing :: Maybe DriveStopButtonCallback.

onDriveStopButton :: (IsDrive a, MonadIO m) => a -> DriveStopButtonCallback -> m SignalHandlerId

Connect a signal handler for the stopButton signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on drive #stopButton callback

wrap_DriveStopButtonCallback :: DriveStopButtonCallback -> C_DriveStopButtonCallback

Wrap a DriveStopButtonCallback into a C_DriveStopButtonCallback.