Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gio.Interfaces.Mount

Contents

Exported types
Methods
Signals

Description

The GMount interface represents a user-visible mount, such as a mounted file system.

GMount is a ‘mounted’ filesystem that you can access. Mounted is in quotes because it’s not the same as a UNIX mount, it might be a GVFS mount, but you can still access the files on it if you use GIO.

A GMount might be associated with a Volume (such as a USB flash drive) which hosts it.

Unmounting a GMount instance is an asynchronous operation. For more information about asynchronous operations, see AsyncResult and Task. To unmount a GMount instance, first call mountUnmountWithOperation with (at least) the GMount instance and a [typegio.AsyncReadyCallback]. The callback will be fired when the operation has resolved (either with success or failure), and a AsyncResult structure will be passed to the callback. That callback should then call mountUnmountWithOperationFinish with the GMount and the AsyncResult data to see if the operation was completed successfully. If an error is present when mountUnmountWithOperationFinish is called, then it will be filled with any error information.

Note, when porting from GnomeVFS, GMount is the moral equivalent of GnomeVFSVolume.

Synopsis

newtype Mount = Mount (ManagedPtr Mount)
class (GObject o, IsDescendantOf Mount o) => IsMount o
toMount :: (MonadIO m, IsMount o) => o -> m Mount
type family ResolveMountMethod (t :: Symbol) o where ...
data MountCanEjectMethodInfo
mountCanEject :: (HasCallStack, MonadIO m, IsMount a) => a -> m Bool
data MountCanUnmountMethodInfo
mountCanUnmount :: (HasCallStack, MonadIO m, IsMount a) => a -> m Bool
data MountEjectMethodInfo
mountEject :: (HasCallStack, MonadIO m, IsMount a, IsCancellable b) => a -> [MountUnmountFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data MountEjectFinishMethodInfo
mountEjectFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m ()
data MountEjectWithOperationMethodInfo
mountEjectWithOperation :: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => a -> [MountUnmountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data MountEjectWithOperationFinishMethodInfo
mountEjectWithOperationFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m ()
data MountGetDefaultLocationMethodInfo
mountGetDefaultLocation :: (HasCallStack, MonadIO m, IsMount a) => a -> m File
data MountGetDriveMethodInfo
mountGetDrive :: (HasCallStack, MonadIO m, IsMount a) => a -> m (Maybe Drive)
data MountGetIconMethodInfo
mountGetIcon :: (HasCallStack, MonadIO m, IsMount a) => a -> m Icon
data MountGetNameMethodInfo
mountGetName :: (HasCallStack, MonadIO m, IsMount a) => a -> m Text
data MountGetRootMethodInfo
mountGetRoot :: (HasCallStack, MonadIO m, IsMount a) => a -> m File
data MountGetSortKeyMethodInfo
mountGetSortKey :: (HasCallStack, MonadIO m, IsMount a) => a -> m (Maybe Text)
data MountGetSymbolicIconMethodInfo
mountGetSymbolicIcon :: (HasCallStack, MonadIO m, IsMount a) => a -> m Icon
data MountGetUuidMethodInfo
mountGetUuid :: (HasCallStack, MonadIO m, IsMount a) => a -> m (Maybe Text)
data MountGetVolumeMethodInfo
mountGetVolume :: (HasCallStack, MonadIO m, IsMount a) => a -> m (Maybe Volume)
data MountGuessContentTypeMethodInfo
mountGuessContentType :: (HasCallStack, MonadIO m, IsMount a, IsCancellable b) => a -> Bool -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data MountGuessContentTypeFinishMethodInfo
mountGuessContentTypeFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m [Text]
data MountGuessContentTypeSyncMethodInfo
mountGuessContentTypeSync :: (HasCallStack, MonadIO m, IsMount a, IsCancellable b) => a -> Bool -> Maybe b -> m [Text]
data MountIsShadowedMethodInfo
mountIsShadowed :: (HasCallStack, MonadIO m, IsMount a) => a -> m Bool
data MountRemountMethodInfo
mountRemount :: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => a -> [MountMountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data MountRemountFinishMethodInfo
mountRemountFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m ()
data MountShadowMethodInfo
mountShadow :: (HasCallStack, MonadIO m, IsMount a) => a -> m ()
data MountUnmountMethodInfo
mountUnmount :: (HasCallStack, MonadIO m, IsMount a, IsCancellable b) => a -> [MountUnmountFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data MountUnmountFinishMethodInfo
mountUnmountFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m ()
data MountUnmountWithOperationMethodInfo
mountUnmountWithOperation :: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => a -> [MountUnmountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data MountUnmountWithOperationFinishMethodInfo
mountUnmountWithOperationFinish :: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b) => a -> b -> m ()
data MountUnshadowMethodInfo
mountUnshadow :: (HasCallStack, MonadIO m, IsMount a) => a -> m ()
type MountChangedCallback = IO ()
data MountChangedSignalInfo
afterMountChanged :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountChangedCallback) -> m SignalHandlerId
onMountChanged :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountChangedCallback) -> m SignalHandlerId
type MountPreUnmountCallback = IO ()
data MountPreUnmountSignalInfo
afterMountPreUnmount :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountPreUnmountCallback) -> m SignalHandlerId
onMountPreUnmount :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountPreUnmountCallback) -> m SignalHandlerId
type MountUnmountedCallback = IO ()
data MountUnmountedSignalInfo
afterMountUnmounted :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountUnmountedCallback) -> m SignalHandlerId
onMountUnmounted :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountUnmountedCallback) -> m SignalHandlerId

Exported types

newtype Mount Source #

Memory-managed wrapper type.

Constructors

Mount (ManagedPtr Mount)

Instances

Instances details

Eq Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods (==) :: Mount -> Mount -> Bool # (/=) :: Mount -> Mount -> Bool #
GObject Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount
ManagedPtrNewtype Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods toManagedPtr :: Mount -> ManagedPtr Mount #
TypedObject Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods glibType :: IO GType #
HasParentTypes Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount
HasAttributeList Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount
(info ~ ResolveMountMethod t Mount, OverloadedMethod info Mount p, HasField t Mount p) => HasField (t :: Symbol) Mount (p :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods getField :: Mount -> p #
(info ~ ResolveMountMethod t Mount, OverloadedMethodInfo info Mount) => IsLabel t (MethodProxy info Mount) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods fromLabel :: MethodProxy info Mount #
(info ~ ResolveMountMethod t Mount, OverloadedMethod info Mount p) => IsLabel t (Mount -> p) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods fromLabel :: Mount -> p #
IsGValue (Maybe Mount) Source #	Convert `Mount` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Interfaces.Mount Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Mount -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Mount) #
type AttributeList Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount type AttributeList Mount
type ParentTypes Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount type ParentTypes Mount = '[Object]
type SignalList Mount Source #
Instance details Defined in GI.Gio.Interfaces.Mount type SignalList Mount

class (GObject o, IsDescendantOf Mount o) => IsMount o Source #

Type class for types which can be safely cast to Mount, for instance with toMount.

Instances

Instances details

(GObject o, IsDescendantOf Mount o) => IsMount o Source #
Instance details Defined in GI.Gio.Interfaces.Mount

toMount :: (MonadIO m, IsMount o) => o -> m Mount Source #

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

Methods

Click to display all available methods, including inherited ones

Expand

type family ResolveMountMethod (t :: Symbol) o where ... Source #

Equations

ResolveMountMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveMountMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveMountMethod "canEject" o = MountCanEjectMethodInfo
ResolveMountMethod "canUnmount" o = MountCanUnmountMethodInfo
ResolveMountMethod "eject" o = MountEjectMethodInfo
ResolveMountMethod "ejectFinish" o = MountEjectFinishMethodInfo
ResolveMountMethod "ejectWithOperation" o = MountEjectWithOperationMethodInfo
ResolveMountMethod "ejectWithOperationFinish" o = MountEjectWithOperationFinishMethodInfo
ResolveMountMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveMountMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveMountMethod "getv" o = ObjectGetvMethodInfo
ResolveMountMethod "guessContentType" o = MountGuessContentTypeMethodInfo
ResolveMountMethod "guessContentTypeFinish" o = MountGuessContentTypeFinishMethodInfo
ResolveMountMethod "guessContentTypeSync" o = MountGuessContentTypeSyncMethodInfo
ResolveMountMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveMountMethod "isShadowed" o = MountIsShadowedMethodInfo
ResolveMountMethod "notify" o = ObjectNotifyMethodInfo
ResolveMountMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveMountMethod "ref" o = ObjectRefMethodInfo
ResolveMountMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveMountMethod "remount" o = MountRemountMethodInfo
ResolveMountMethod "remountFinish" o = MountRemountFinishMethodInfo
ResolveMountMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveMountMethod "shadow" o = MountShadowMethodInfo
ResolveMountMethod "stealData" o = ObjectStealDataMethodInfo
ResolveMountMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveMountMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveMountMethod "unmount" o = MountUnmountMethodInfo
ResolveMountMethod "unmountFinish" o = MountUnmountFinishMethodInfo
ResolveMountMethod "unmountWithOperation" o = MountUnmountWithOperationMethodInfo
ResolveMountMethod "unmountWithOperationFinish" o = MountUnmountWithOperationFinishMethodInfo
ResolveMountMethod "unref" o = ObjectUnrefMethodInfo
ResolveMountMethod "unshadow" o = MountUnshadowMethodInfo
ResolveMountMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveMountMethod "getData" o = ObjectGetDataMethodInfo
ResolveMountMethod "getDefaultLocation" o = MountGetDefaultLocationMethodInfo
ResolveMountMethod "getDrive" o = MountGetDriveMethodInfo
ResolveMountMethod "getIcon" o = MountGetIconMethodInfo
ResolveMountMethod "getName" o = MountGetNameMethodInfo
ResolveMountMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveMountMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveMountMethod "getRoot" o = MountGetRootMethodInfo
ResolveMountMethod "getSortKey" o = MountGetSortKeyMethodInfo
ResolveMountMethod "getSymbolicIcon" o = MountGetSymbolicIconMethodInfo
ResolveMountMethod "getUuid" o = MountGetUuidMethodInfo
ResolveMountMethod "getVolume" o = MountGetVolumeMethodInfo
ResolveMountMethod "setData" o = ObjectSetDataMethodInfo
ResolveMountMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveMountMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveMountMethod l o = MethodResolutionFailed l o :: Type

canEject

data MountCanEjectMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsMount a) => OverloadedMethod MountCanEjectMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountCanEjectMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountCanEject Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m Bool	Returns: `True` if the `mount` can be ejected.

Checks if mount can be ejected.

canUnmount

data MountCanUnmountMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsMount a) => OverloadedMethod MountCanUnmountMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountCanUnmountMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountCanUnmount Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m Bool	Returns: `True` if the `mount` can be unmounted.

Checks if mount can be unmounted.

eject

data MountEjectMethodInfo Source #

Instances

Instances details

(signature ~ ([MountUnmountFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsCancellable b) => OverloadedMethod MountEjectMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountEjectMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountEject Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsCancellable b)
=> a	`mount`: a `Mount`.
-> [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 mountEjectWithOperation instead.

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

ejectFinish

data MountEjectFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountEjectFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountEjectFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountEjectFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

Deprecated: (Since version 2.22)Use mountEjectWithOperationFinish instead.

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

ejectWithOperation

data MountEjectWithOperationMethodInfo Source #

Instances

Instances details

(signature ~ ([MountUnmountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => OverloadedMethod MountEjectWithOperationMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountEjectWithOperationMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountEjectWithOperation Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c)
=> a	`mount`: a `Mount`.
-> [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 mount. This is an asynchronous operation, and is finished by calling mountEjectWithOperationFinish with the mount and AsyncResult data returned in the callback.

Since: 2.22

ejectWithOperationFinish

data MountEjectWithOperationFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountEjectWithOperationFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountEjectWithOperationFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountEjectWithOperationFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

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

Since: 2.22

getDefaultLocation

data MountGetDefaultLocationMethodInfo Source #

Instances

Instances details

(signature ~ m File, MonadIO m, IsMount a) => OverloadedMethod MountGetDefaultLocationMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetDefaultLocationMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetDefaultLocation Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m File	Returns: a `File`. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the default location of mount. The default location of the given mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume).

getDrive

data MountGetDriveMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Drive), MonadIO m, IsMount a) => OverloadedMethod MountGetDriveMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetDriveMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetDrive Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m (Maybe Drive)	Returns: a `Drive` or `Nothing` if `mount` is not associated with a volume or a drive. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the drive for the mount.

This is a convenience method for getting the Volume and then using that object to get the Drive.

getIcon

data MountGetIconMethodInfo Source #

Instances

Instances details

(signature ~ m Icon, MonadIO m, IsMount a) => OverloadedMethod MountGetIconMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetIconMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m Icon	Returns: a `Icon`. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the icon for mount.

getName

data MountGetNameMethodInfo Source #

Instances

Instances details

(signature ~ m Text, MonadIO m, IsMount a) => OverloadedMethod MountGetNameMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetNameMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m Text	Returns: the name for the given `mount`. The returned string should be freed with `free` when no longer needed.

Gets the name of mount.

getRoot

data MountGetRootMethodInfo Source #

Instances

Instances details

(signature ~ m File, MonadIO m, IsMount a) => OverloadedMethod MountGetRootMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetRootMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetRoot Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m File	Returns: a `File`. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the root directory on mount.

getSortKey

data MountGetSortKeyMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsMount a) => OverloadedMethod MountGetSortKeyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetSortKeyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetSortKey Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: A `Mount`.
-> m (Maybe Text)	Returns: Sorting key for `mount` or `Nothing` if no such key is available.

Gets the sort key for mount, if any.

Since: 2.32

getSymbolicIcon

data MountGetSymbolicIconMethodInfo Source #

Instances

Instances details

(signature ~ m Icon, MonadIO m, IsMount a) => OverloadedMethod MountGetSymbolicIconMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetSymbolicIconMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetSymbolicIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m Icon	Returns: a `Icon`. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the symbolic icon for mount.

Since: 2.34

getUuid

data MountGetUuidMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsMount a) => OverloadedMethod MountGetUuidMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetUuidMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetUuid Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m (Maybe Text)	Returns: the UUID for `mount` or `Nothing` if no UUID can be computed. The returned string should be freed with `free` when no longer needed.

Gets the UUID for the mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns Nothing if there is no UUID available.

getVolume

data MountGetVolumeMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Volume), MonadIO m, IsMount a) => OverloadedMethod MountGetVolumeMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGetVolumeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGetVolume Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: a `Mount`.
-> m (Maybe Volume)	Returns: a `Volume` or `Nothing` if `mount` is not associated with a volume. The returned object should be unreffed with `objectUnref` when no longer needed.

Gets the volume for the mount.

guessContentType

data MountGuessContentTypeMethodInfo Source #

Instances

Instances details

(signature ~ (Bool -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsCancellable b) => OverloadedMethod MountGuessContentTypeMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGuessContentTypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGuessContentType Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsCancellable b)
=> a	`mount`: a `Mount`
-> Bool	`forceRescan`: Whether to force a rescan of the content. Otherwise a cached result will be used if available
-> Maybe b	`cancellable`: optional `Cancellable` object, `Nothing` to ignore
-> Maybe AsyncReadyCallback	`callback`: a `AsyncReadyCallback`
-> m ()

Tries to guess the type of content stored on mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the shared-mime-info specification for more on x-content types.

This is an asynchronous operation (see mountGuessContentTypeSync for the synchronous version), and is finished by calling mountGuessContentTypeFinish with the mount and AsyncResult data returned in the callback.

Since: 2.18

guessContentTypeFinish

data MountGuessContentTypeFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m [Text]), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountGuessContentTypeFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGuessContentTypeFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGuessContentTypeFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`
-> b	`result`: a `AsyncResult`
-> m [Text]	Returns: a `Nothing`-terminated array of content types or `Nothing` on error. Caller should free this array with `strfreev` when done with it. (Can throw `GError`)

Finishes guessing content types of mount. If any errors occurred during the operation, error will be set to contain the errors and False will be returned. In particular, you may get an IOErrorEnumNotSupported if the mount does not support content guessing.

Since: 2.18

guessContentTypeSync

data MountGuessContentTypeSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Bool -> Maybe b -> m [Text]), MonadIO m, IsMount a, IsCancellable b) => OverloadedMethod MountGuessContentTypeSyncMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountGuessContentTypeSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountGuessContentTypeSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsCancellable b)
=> a	`mount`: a `Mount`
-> Bool	`forceRescan`: Whether to force a rescan of the content. Otherwise a cached result will be used if available
-> Maybe b	`cancellable`: optional `Cancellable` object, `Nothing` to ignore
-> m [Text]	Returns: a `Nothing`-terminated array of content types or `Nothing` on error. Caller should free this array with `strfreev` when done with it. (Can throw `GError`)

Tries to guess the type of content stored on mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the shared-mime-info specification for more on x-content types.

This is a synchronous operation and as such may block doing IO; see mountGuessContentType for the asynchronous version.

Since: 2.18

isShadowed

data MountIsShadowedMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsMount a) => OverloadedMethod MountIsShadowedMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountIsShadowedMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountIsShadowed Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: A `Mount`.
-> m Bool	Returns: `True` if `mount` is shadowed.

Determines if mount is shadowed. Applications or libraries should avoid displaying mount in the user interface if it is shadowed.

A mount is said to be shadowed if there exists one or more user visible objects (currently Mount objects) with a root that is inside the root of mount.

One application of shadow mounts is when exposing a single file system that is used to address several logical volumes. In this situation, a VolumeMonitor implementation would create two Volume objects (for example, one for the camera functionality of the device and one for a SD card reader on the device) with activation URIs gphoto2://[usb:001,002]/store1/ and gphoto2://[usb:001,002]/store2/. When the underlying mount (with root gphoto2://[usb:001,002]/) is mounted, said VolumeMonitor implementation would create two Mount objects (each with their root matching the corresponding volume activation root) that would shadow the original mount.

The proxy monitor in GVfs 2.26 and later, automatically creates and manage shadow mounts (and shadows the underlying mount) if the activation root on a Volume is set.

Since: 2.20

remount

data MountRemountMethodInfo Source #

Instances

Instances details

(signature ~ ([MountMountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => OverloadedMethod MountRemountMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountRemountMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountRemount Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c)
=> a	`mount`: a `Mount`.
-> [MountMountFlags]	`flags`: flags affecting the 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 ()

Remounts a mount. This is an asynchronous operation, and is finished by calling mountRemountFinish with the mount and GAsyncResults data returned in the callback.

Remounting is useful when some setting affecting the operation of the volume has been changed, as these may need a remount to take affect. While this is semantically equivalent with unmounting and then remounting not all backends might need to actually be unmounted.

remountFinish

data MountRemountFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountRemountFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountRemountFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountRemountFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

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

shadow

data MountShadowMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m, IsMount a) => OverloadedMethod MountShadowMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountShadowMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountShadow Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: A `Mount`.
-> m ()

Increments the shadow count on mount. Usually used by VolumeMonitor implementations when creating a shadow mount for mount, see mountIsShadowed for more information. The caller will need to emit the Mount::changed signal on mount manually.

Since: 2.20

unmount

data MountUnmountMethodInfo Source #

Instances

Instances details

(signature ~ ([MountUnmountFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsCancellable b) => OverloadedMethod MountUnmountMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountUnmountMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountUnmount Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsCancellable b)
=> a	`mount`: a `Mount`.
-> [MountUnmountFlags]	`flags`: flags affecting the operation
-> Maybe b	`cancellable`: optional `Cancellable` object, `Nothing` to ignore.
-> Maybe AsyncReadyCallback	`callback`: a `AsyncReadyCallback`, or `Nothing`.
-> m ()

Deprecated: (Since version 2.22)Use mountUnmountWithOperation instead.

Unmounts a mount. This is an asynchronous operation, and is finished by calling mountUnmountFinish with the mount and AsyncResult data returned in the callback.

unmountFinish

data MountUnmountFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountUnmountFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountUnmountFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountUnmountFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

Deprecated: (Since version 2.22)Use mountUnmountWithOperationFinish instead.

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

unmountWithOperation

data MountUnmountWithOperationMethodInfo Source #

Instances

Instances details

(signature ~ ([MountUnmountFlags] -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMount a, IsMountOperation b, IsCancellable c) => OverloadedMethod MountUnmountWithOperationMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountUnmountWithOperationMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountUnmountWithOperation Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsMountOperation b, IsCancellable c)
=> a	`mount`: a `Mount`.
-> [MountUnmountFlags]	`flags`: flags affecting the 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 ()

Unmounts a mount. This is an asynchronous operation, and is finished by calling mountUnmountWithOperationFinish with the mount and AsyncResult data returned in the callback.

Since: 2.22

unmountWithOperationFinish

data MountUnmountWithOperationFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsMount a, IsAsyncResult b) => OverloadedMethod MountUnmountWithOperationFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountUnmountWithOperationFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountUnmountWithOperationFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a, IsAsyncResult b)
=> a	`mount`: a `Mount`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

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

Since: 2.22

unshadow

data MountUnshadowMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m, IsMount a) => OverloadedMethod MountUnshadowMethodInfo a signature Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo MountUnshadowMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Interfaces.Mount Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

mountUnshadow Source #

Arguments

:: (HasCallStack, MonadIO m, IsMount a)
=> a	`mount`: A `Mount`.
-> m ()

Decrements the shadow count on mount. Usually used by VolumeMonitor implementations when destroying a shadow mount for mount, see mountIsShadowed for more information. The caller will need to emit the Mount::changed signal on mount manually.

Since: 2.20

Signals

changed

type MountChangedCallback = IO () Source #

Emitted when the mount has been changed.

data MountChangedSignalInfo Source #

Instances

Instances details

SignalInfo MountChangedSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

Associated Types

type HaskellCallbackType MountChangedSignalInfo
Instance details Defined in GI.Gio.Interfaces.Mount type HaskellCallbackType MountChangedSignalInfo = MountChangedCallback

Methods

connectSignal :: GObject o => o -> (o -> HaskellCallbackType MountChangedSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId #

dbgSignalInfo :: Maybe ResolvedSymbolInfo #

type HaskellCallbackType MountChangedSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

type HaskellCallbackType MountChangedSignalInfo = MountChangedCallback

afterMountChanged :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountChangedCallback) -> m SignalHandlerId Source #

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

after mount #changed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountChanged :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountChangedCallback) -> m SignalHandlerId Source #

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

on mount #changed callback

preUnmount

type MountPreUnmountCallback = IO () Source #

This signal may be emitted when the Mount is about to be unmounted.

This signal depends on the backend and is only emitted if GIO was used to unmount.

Since: 2.22

data MountPreUnmountSignalInfo Source #

Instances

Instances details

SignalInfo MountPreUnmountSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

Associated Types

type HaskellCallbackType MountPreUnmountSignalInfo
Instance details Defined in GI.Gio.Interfaces.Mount type HaskellCallbackType MountPreUnmountSignalInfo = MountPreUnmountCallback

Methods

connectSignal :: GObject o => o -> (o -> HaskellCallbackType MountPreUnmountSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId #

dbgSignalInfo :: Maybe ResolvedSymbolInfo #

type HaskellCallbackType MountPreUnmountSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

type HaskellCallbackType MountPreUnmountSignalInfo = MountPreUnmountCallback

afterMountPreUnmount :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountPreUnmountCallback) -> m SignalHandlerId Source #

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

after mount #preUnmount callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountPreUnmount :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountPreUnmountCallback) -> m SignalHandlerId Source #

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

on mount #preUnmount callback

unmounted

type MountUnmountedCallback = IO () Source #

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

data MountUnmountedSignalInfo Source #

Instances

Instances details

SignalInfo MountUnmountedSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

Associated Types

type HaskellCallbackType MountUnmountedSignalInfo
Instance details Defined in GI.Gio.Interfaces.Mount type HaskellCallbackType MountUnmountedSignalInfo = MountUnmountedCallback

Methods

connectSignal :: GObject o => o -> (o -> HaskellCallbackType MountUnmountedSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId #

dbgSignalInfo :: Maybe ResolvedSymbolInfo #

type HaskellCallbackType MountUnmountedSignalInfo Source #

Instance details

Defined in GI.Gio.Interfaces.Mount

type HaskellCallbackType MountUnmountedSignalInfo = MountUnmountedCallback

afterMountUnmounted :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountUnmountedCallback) -> m SignalHandlerId Source #

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

after mount #unmounted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountUnmounted :: (IsMount a, MonadIO m) => a -> ((?self :: a) => MountUnmountedCallback) -> m SignalHandlerId Source #

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

on mount #unmounted callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

canEject

Instances

canUnmount

Instances

eject

Instances

ejectFinish

Instances

ejectWithOperation

Instances

ejectWithOperationFinish

Instances

getDefaultLocation

Instances

getDrive

Instances

getIcon

Instances

getName

Instances

getRoot

Instances

getSortKey

Instances

getSymbolicIcon

Instances

getUuid

Instances

getVolume

Instances

guessContentType

Instances

guessContentTypeFinish

Instances

guessContentTypeSync

Instances

isShadowed

Instances

remount

Instances

remountFinish

Instances

shadow

Instances

unmount

Instances

unmountFinish

Instances

unmountWithOperation

Instances

unmountWithOperationFinish

Instances

unshadow

Instances

Signals

changed

Instances

preUnmount

Instances

unmounted

Instances