-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Binding to the GIO. -- -- GIO is striving to provide a modern, easy-to-use VFS API that sits at -- the right level in the library stack. The goal is to overcome the -- shortcomings of GnomeVFS and provide an API that is so good that -- developers prefer it over raw POSIX calls. Among other things that -- means using GObject. It also means not cloning the POSIX API, but -- providing higher-level, document-centric interfaces. @package gio @version 0.11.1 module System.GIO.Base type Offset = CLLong cToFlags :: (Integral int, Flags flags) => int -> [flags] cFromFlags :: (Integral int, Flags flags) => [flags] -> int cToEnum :: (Integral int, Enum enum) => int -> enum cFromEnum :: (Integral int, Enum enum) => enum -> int withGObject :: GObjectClass objectT => objectT -> (Ptr objectT -> IO a) -> IO a peekGObject :: GObjectClass obj => Ptr obj -> IO obj objectFinalizer :: FunPtr (Ptr () -> IO ()) cObjectRef :: Ptr () -> IO (Ptr ()) takeGObject :: GObjectClass obj => Ptr obj -> IO obj type AsyncReadyCallback = GObject -> AsyncResult -> IO () type CAsyncReadyCallback = Ptr GObject -> Ptr AsyncResult -> Ptr () -> IO () makeAsyncReadyCallback :: CAsyncReadyCallback -> IO ((FunPtr ((Ptr ()) -> ((Ptr AsyncResult) -> ((Ptr ()) -> (IO ())))))) marshalAsyncReadyCallback :: AsyncReadyCallback -> IO ((FunPtr ((Ptr ()) -> ((Ptr AsyncResult) -> ((Ptr ()) -> (IO ())))))) data FileAttributeInfoFlags FileAttributeInfoNone :: FileAttributeInfoFlags FileAttributeInfoCopyWithFile :: FileAttributeInfoFlags FileAttributeInfoCopyWhenMoved :: FileAttributeInfoFlags instance Eq FileAttributeInfoFlags instance Ord FileAttributeInfoFlags instance Bounded FileAttributeInfoFlags instance Read FileAttributeInfoFlags instance Show FileAttributeInfoFlags instance Flags FileAttributeInfoFlags instance Enum FileAttributeInfoFlags module System.GIO.File.FileAttribute data FileAttributeType FileAttributeTypeInvalid :: FileAttributeType FileAttributeTypeString :: FileAttributeType FileAttributeTypeByteString :: FileAttributeType FileAttributeTypeBool :: FileAttributeType FileAttributeTypeWord32 :: FileAttributeType FileAttributeTypeInt32 :: FileAttributeType FileAttributeTypeWord64 :: FileAttributeType FileAttributeTypeInt64 :: FileAttributeType FileAttributeTypeObject :: FileAttributeType data FileAttributeInfo FileAttributeInfo :: String -> FileAttributeType -> [FileAttributeInfoFlags] -> FileAttributeInfo fileAttributeInfoName :: FileAttributeInfo -> String fileAttributeInfoType :: FileAttributeInfo -> FileAttributeType fileAttributeInfoFlags :: FileAttributeInfo -> [FileAttributeInfoFlags] data FileAttributeInfoFlags FileAttributeInfoNone :: FileAttributeInfoFlags FileAttributeInfoCopyWithFile :: FileAttributeInfoFlags FileAttributeInfoCopyWhenMoved :: FileAttributeInfoFlags fileAttributeStandardType :: String fileAttributeStandardIsHidden :: String fileAttributeStandardIsBackup :: String fileAttributeStandardIsSymlink :: String fileAttributeStandardIsVirtual :: String fileAttributeStandardName :: String fileAttributeStandardDisplayName :: String fileAttributeStandardEditName :: String fileAttributeStandardCopyName :: String fileAttributeStandardIcon :: String fileAttributeStandardContentType :: String fileAttributeStandardFastContentType :: String fileAttributeStandardSize :: String fileAttributeStandardSymlinkTarget :: String fileAttributeStandardTargetURI :: String fileAttributeStandardSortOrder :: String fileAttributeEtagValue :: String fileAttributeIDFile :: String fileAttributeIDFilesystem :: String fileAttributeAccessCanRead :: String fileAttributeAccessCanWrite :: String fileAttributeAccessCanExecute :: String fileAttributeAccessCanDelete :: String fileAttributeAccessCanTrash :: String fileAttributeAccessCanRename :: String fileAttributeMountableCanMount :: String fileAttributeMountableCanUnmount :: String fileAttributeMountableCanEject :: String fileAttributeMountableUnixDevice :: String fileAttributeMountableHalUDI :: String fileAttributeTimeModified :: String fileAttributeTimeModifiedUSec :: String fileAttributeTimeAccess :: String fileAttributeTimeAccessUSec :: String fileAttributeTimeChanged :: String fileAttributeTimeChangedUSec :: String fileAttributeTimeCreated :: String fileAttributeTimeCreatedUSec :: String fileAttributeUnixDevice :: String fileAttributeUnixInode :: String fileAttributeUnixMode :: String fileAttributeUnixNLink :: String fileAttributeUnixUID :: String fileAttributeUnixGID :: String fileAttributeUnixRDev :: String fileAttributeUnixBlockSize :: String fileAttributeUnixBlocks :: String fileAttributeDosIsArchive :: String fileAttributeDosIsSystem :: String fileAttributeOwnerUser :: String fileAttributeOwnerUserReal :: String fileAttributeOwnerGroup :: String fileAttributeThumbnailPath :: String fileAttributeThumbnailingFailed :: String fileAttributeFilesystemSize :: String fileAttributeFilesystemFree :: String fileAttributeFilesystemType :: String fileAttributeFilesystemReadonly :: String fileAttributeGVfsBackend :: String fileAttributeSELinuxContext :: String fileAttributeTrashItemCount :: String fileAttributeFilesystemUsePreview :: String fileAttributeStandardDescription :: String instance Eq FileAttributeInfo instance Read FileAttributeInfo instance Show FileAttributeInfo instance Eq FileAttributeType instance Ord FileAttributeType instance Bounded FileAttributeType instance Show FileAttributeType instance Read FileAttributeType instance Storable FileAttributeInfo instance Enum FileAttributeType module System.GIO.File.File type FileProgressCallback = Offset -> Offset -> IO () type FileReadMoreCallback = ByteString -> IO Bool class GObjectClass o => FileClass o newtype File File :: (ForeignPtr (File)) -> File data FileQueryInfoFlags FileQueryInfoNone :: FileQueryInfoFlags FileQueryInfoNofollowSymlinks :: FileQueryInfoFlags data FileCreateFlags FileCreateNone :: FileCreateFlags FileCreatePrivate :: FileCreateFlags FileCreateReplaceDestination :: FileCreateFlags data FileCopyFlags FileCopyNone :: FileCopyFlags FileCopyOverwrite :: FileCopyFlags FileCopyBackup :: FileCopyFlags FileCopyNofollowSymlinks :: FileCopyFlags FileCopyAllMetadata :: FileCopyFlags FileCopyNoFallbackForMove :: FileCopyFlags FileCopyTargetDefaultPerms :: FileCopyFlags data FileMonitorFlags FileMonitorNone :: FileMonitorFlags FileMonitorWatchMounts :: FileMonitorFlags FileMonitorSendMoved :: FileMonitorFlags data FilesystemPreviewType FilesystemPreviewTypeIfAlways :: FilesystemPreviewType FilesystemPreviewTypeIfLocal :: FilesystemPreviewType FilesystemPreviewTypeNever :: FilesystemPreviewType data FileType FileTypeUnknown :: FileType FileTypeRegular :: FileType FileTypeDirectory :: FileType FileTypeSymbolicLink :: FileType FileTypeSpecial :: FileType FileTypeShortcut :: FileType FileTypeMountable :: FileType -- | Constructs a GFile for a given path. This operation never fails, but -- the returned object might not support any I/O operation if path is -- malformed. fileFromPath :: FilePath -> File -- | Constructs a GFile for a given URI. This operation never fails, but -- the returned object might not support any I/O operation if uri is -- malformed or if the uri type is not supported. fileFromURI :: String -> File -- | Creates a GFile with the given argument from the command line. The -- value of arg can be either a URI, an absolute path or a relative path -- resolved relative to the current working directory. This operation -- never fails, but the returned object might not support any I/O -- operation if arg points to a malformed path. fileFromCommandlineArg :: String -> File -- | Constructs a GFile with the given 'name (i.e. something given by -- gFileGetParseName'. This operation never fails, but the returned -- object might not support any I/O operation if the parseName -- cannot be parsed. fileFromParseName :: String -> File -- | Compare two file descriptors for equality. This test is also used to -- implement the '(==)' function, that is, comparing two descriptions -- will compare their content, not the pointers to the two structures. fileEqual :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool -- | Gets the base name (the last component of the path) for a given GFile. -- -- If called for the top level of a system (such as the filesystem root -- or a uri like sftp: will return a single directory separator (and on -- Windows, possibly a drive letter). -- -- The base name is a byte string (*not* UTF-8). It has no defined -- encoding or rules other than it may not contain zero bytes. If you -- want to use filenames in a user interface you should use the display -- name that you can get by requesting the -- GFileAttributeStandardDisplayName attribute with fileQueryInfo. -- -- This call does no blocking i/o. fileBasename :: FileClass file => file -> String -- | Gets the local pathname for GFile, if one exists. -- -- This call does no blocking i/o. filePath :: FileClass file => file -> FilePath -- | Checks if file has a parent, and optionally, if it is parent. -- -- If parent is Nothing then this function returns True if -- file has any parent at all. If parent is non-Nothing then -- True is only returned if file is a child of parent. fileHasParent :: FileClass file => file -> Maybe File -> Bool -- | Gets the URI for the file. -- -- This call does no blocking i/o. fileURI :: FileClass file => file -> String -- | Gets the parse name of the file. A parse name is a UTF-8 string that -- describes the file such that one can get the GFile back using -- fileParseName. -- -- This is generally used to show the GFile as a nice full-pathname kind -- of string in a user interface, like in a location entry. -- -- For local files with names that can safely be converted to UTF8 the -- pathname is used, otherwise the IRI is used (a form of URI that allows -- UTF8 characters unescaped). -- -- This call does no blocking i/o. fileParseName :: FileClass file => file -> String -- | Gets a child of file with basename equal to name. -- -- Note that the file with that specific name might not exist, but you -- can still have a GFile that points to it. You can use this for -- instance to create that file. -- -- This call does no blocking i/o. fileGetChild :: FileClass file => file -> String -> File -- | Gets the child of file for a given 'name (i.e. a UTF8 version of the -- name)'. If this function fails, it returns Nothing and error -- will be set. This is very useful when constructing a GFile for a new -- file and the user entered the filename in the user interface, for -- instance when you select a directory and type a filename in the file -- selector. -- -- This call does no blocking i/o. fileGetChildForDisplayName :: FileClass file => file -> String -> Maybe File -- | Checks whether file has the prefix specified by prefix. In other word, -- if the names of inital elements of files pathname match prefix. Only -- full pathname elements are matched, so a path like foo is not -- considered a prefix of foobar, only of foobar. -- -- This call does no i/o, as it works purely on names. As such it can -- sometimes return False even if file is inside a prefix (from a -- filesystem point of view), because the prefix of file is an alias of -- prefix. fileHasPrefix :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool -- | Gets the path for descendant relative to parent. -- -- This call does no blocking i/o. fileGetRelativePath :: (FileClass file1, FileClass file2) => file1 -> file2 -> Maybe FilePath -- | Resolves a relative path for file to an absolute path. -- -- This call does no blocking i/o. fileResolveRelativePath :: FileClass file => file -> FilePath -> Maybe File -- | Checks to see if a file is native to the platform. -- -- A native file s one expressed in the platform-native filename format, -- e.g. "C:\Windows" or "usrbin/". This does not mean the file is -- local, as it might be on a locally mounted remote filesystem. -- -- On some systems non-native files may be available using the native -- filesystem via a userspace filesystem (FUSE), in these cases this call -- will return False, but fileGetPath will still return -- a native path. -- -- This call does no blocking i/o. fileIsNative :: FileClass file => file -> Bool -- | Checks to see if a GFile has a given URI scheme. -- -- This call does no blocking i/o. fileHasURIScheme :: FileClass file => file -> String -> Bool -- | Gets the URI scheme for a GFile. RFC 3986 decodes the scheme as: -- -- URI = scheme : hier-part [ ? query ] [ # fragment -- ] -- -- Common schemes include file, http, ftp, etc. -- -- This call does no blocking i/o. fileURIScheme :: FileClass file => file -> String -- | Opens a file for reading. The result is a GFileInputStream that can be -- used to read the contents of the file. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If the file does not exist, the GIoErrorNotFound error will be -- returned. If the file is a directory, the GIoErrorIsDirectory error -- will be returned. Other errors are possible too, and depend on what -- kind of filesystem the file is on. fileRead :: FileClass file => file -> Maybe Cancellable -> IO FileInputStream -- | Asynchronously opens file for reading. -- -- For more details, see fileRead which is the synchronous version -- of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileReadFinish to get the result of the operation. fileReadAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous file read operation started with -- fileReadAsync. fileReadFinish :: FileClass file => file -> AsyncResult -> IO FileInputStream -- | Gets an output stream for appending data to the file. If the file -- doesn't already exist it is created. -- -- By default files created are generally readable by everyone, but if -- you pass GFileCreatePrivate in flags the file will be made readable -- only to the current user, to the level that is supported on the target -- filesystem. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- Some file systems don't allow all file names, and may return an -- GIoErrorInvalidFilename error. If the file is a directory the -- GIoErrorIsDirectory error will be returned. Other errors are possible -- too, and depend on what kind of filesystem the file is on. fileAppendTo :: FileClass file => file -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream -- | Creates a new file and returns an output stream for writing to it. The -- file must not already exist. -- -- By default files created are generally readable by everyone, but if -- you pass GFileCreatePrivate in flags the file will be made readable -- only to the current user, to the level that is supported on the target -- filesystem. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If a file or directory with this name already exists the -- GIoErrorExists error will be returned. Some file systems don't allow -- all file names, and may return an GIoErrorInvalidFilename error, and -- if the name is to long GIoErrorFilenameTooLong will be returned. Other -- errors are possible too, and depend on what kind of filesystem the -- file is on. fileCreate :: FileClass file => file -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream -- | Returns an output stream for overwriting the file, possibly creating a -- backup copy of the file first. If the file doesn't exist, it will be -- created. -- -- This will try to replace the file in the safest way possible so that -- any errors during the writing will not affect an already existing copy -- of the file. For instance, for local files it may write to a temporary -- file and then atomically rename over the destination when the stream -- is closed. -- -- By default files created are generally readable by everyone, but if -- you pass GFileCreatePrivate in flags the file will be made readable -- only to the current user, to the level that is supported on the target -- filesystem. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If you pass in a non-Nothing etag value, then this value is -- compared to the current entity tag of the file, and if they differ an -- GIoErrorWrongEtag error is returned. This generally means that the -- file has been changed since you last read it. You can get the new etag -- from fileOutputStreamGetEtag after you've finished writing -- and closed the GFileOutputStream. When you load a new file you can use -- fileInputStreamQueryInfo to get the etag of the file. -- -- If makeBackup is True, this function will attempt to -- make a backup of the current file before overwriting it. If this fails -- a GIoErrorCantCreateBackup error will be returned. If you want to -- replace anyway, try again with makeBackup set to -- False. -- -- If the file is a directory the GIoErrorIsDirectory error will be -- returned, and if the file is some other form of non-regular file then -- a GIoErrorNotRegularFile error will be returned. Some file systems -- don't allow all file names, and may return an GIoErrorInvalidFilename -- error, and if the name is to long GIoErrorFilenameTooLong will be -- returned. Other errors are possible too, and depend on what kind of -- filesystem the file is on. fileReplace :: FileClass file => file -> Maybe String -> Bool -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream -- | Asynchronously opens file for appending. -- -- For more details, see fileAppendTo which is the synchronous -- version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileAppendToFinish to get the result of the operation. fileAppendToAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous file append operation started with -- fileAppendToAsync. fileAppendToFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream -- | Asynchronously creates a new file and returns an output stream for -- writing to it. The file must not already exist. -- -- For more details, see fileCreate which is the synchronous -- version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileCreateFinish to get the result of the operation. fileCreateAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous file create operation started with -- fileCreateAsync. fileCreateFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream -- | Asynchronously overwrites the file, replacing the contents, possibly -- creating a backup copy of the file first. -- -- For more details, see fileReplace which is the synchronous -- version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileReplaceFinish to get the result of the operation. fileReplaceAsync :: FileClass file => file -> String -> Bool -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous file replace operation started with -- fileReplaceAsync. fileReplaceFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream -- | Gets the requested information about specified file. The result is a -- GFileInfo object that contains key-value attributes (such as -- the type or size of the file). -- -- The attribute value is a string that specifies the file attributes -- that should be gathered. It is not an error if it's not possible to -- read a particular requested attribute from a file - it just won't be -- set. attribute should be a comma-separated list of attribute or -- attribute wildcards. The wildcard "*" means all attributes, and a -- wildcard like "standard::*" means all attributes in the standard -- namespace. An example attribute query be "standard::*,user". -- The standard attributes are available as defines, like -- GFileAttributeStandardName. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will -- be returned. -- -- For symlinks, normally the information about the target of the symlink -- is returned, rather than information about the symlink itself. However -- if you pass GFileQueryInfoNofollowSymlinks in flags the -- information about the symlink itself will be returned. Also, for -- symlinks that point to non-existing files the information about the -- symlink itself will be returned. -- -- If the file does not exist, the GIoErrorNotFound error will -- be returned. Other errors are possible too, and depend on what kind of -- filesystem the file is on. fileQueryInfo :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileInfo -- | Asynchronously gets the requested information about specified file. -- The result is a GFileInfo object that contains key-value -- attributes (such as type or size for the file). -- -- For more details, see fileQueryInfo which is the synchronous -- version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileQueryInfoFinish to get the result of the operation. fileQueryInfoAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous file info query. See -- fileQueryInfoAsync. fileQueryInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo -- | Utility function to check if a particular file exists. This is -- implemented using fileQueryInfo and as such does blocking I/O. -- -- Note that in many cases it is racy to first check for file existence -- and then execute something based on the outcome of that, because the -- file might have been created or removed in between the operations. The -- general approach to handling that is to not check, but just do the -- operation and handle the errors as they come. -- -- As an example of race-free checking, take the case of reading a file, -- and if it doesn't exist, creating it. There are two racy versions: -- read it, and on error create it; and: check if it exists, if not -- create it. These can both result in two processes creating the file -- (with perhaps a partially written file as the result). The correct -- approach is to always try to create the file with fileCreate -- which will either atomically create the file or fail with a -- GIoErrorExists error. -- -- However, in many cases an existence check is useful in a user -- interface, for instance to make a menu item sensitive/ insensitive, so -- that you don't have to fool users that something is possible and then -- just show and error dialog. If you do this, you should make sure to -- also handle the errors that can happen due to races when you execute -- the operation. fileQueryExists :: FileClass file => file -> Maybe Cancellable -> IO Bool -- | Utility function to inspect the GFileType of a file. This is -- implemented using fileQueryInfo and as such does blocking I/O. -- -- The primary use case of this method is to check if a file is a regular -- file, directory, or symlink. fileQueryFileType :: FileClass file => file -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileType -- | Similar to fileQueryInfo, but obtains information about the -- filesystem the file is on, rather than the file itself. For instance -- the amount of space available and the type of the filesystem. -- -- The attribute value is a string that specifies the file attributes -- that should be gathered. It is not an error if it's not possible to -- read a particular requested attribute from a file - it just won't be -- set. attribute should be a comma-separated list of attribute or -- attribute wildcards. The wildcard * means all attributes, and a -- wildcard like fs:* means all attributes in the fs namespace. -- The standard namespace for filesystem attributes is fs. Common -- attributes of interest are 'FILEAttributeFilesystemSize (The Total -- Size Of The Filesystem In Bytes)', 'FILEAttributeFilesystemFree -- (Number Of Bytes Available)', and GFileAttributeFilesystemType (type -- of the filesystem). -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If the file does not exist, the GIoErrorNotFound error will be -- returned. Other errors are possible too, and depend on what kind of -- filesystem the file is on. fileQueryFilesystemInfo :: FileClass file => file -> String -> Maybe Cancellable -> IO FileInfo -- | Asynchronously gets the requested information about the filesystem -- that the specified file is on. The result is a GFileInfo object that -- contains key-value attributes (such as type or size for the file). -- -- For more details, see fileQueryFilesystemInfo which is the -- synchronous version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileQueryInfoFinish to get the result of the operation. fileQueryFilesystemInfoAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous filesystem info query. See -- fileQueryFilesystemInfoAsync. fileQueryFilesystemInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo -- | Returns the GAppInfo that is registered as the default application to -- handle the file specified by file. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileQueryDefaultHandler :: FileClass file => file -> Maybe Cancellable -> IO AppInfo -- | Gets a GMount for the GFile. -- -- If the GFileIface for file does not have a mount (e.g. possibly a -- remote share), error will be set to GIoErrorNotFound and -- Nothing will be returned. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileFindEnclosingMount :: FileClass file => file -> Maybe Cancellable -> IO Mount -- | Asynchronously gets the mount for the file. -- -- For more details, see fileFindEnclosingMount which is the -- synchronous version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileFindEnclosingMountFinish to get the result of the -- operation. fileFindEnclosingMountAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an asynchronous find mount request. See -- fileFindEnclosingMountAsync. fileFindEnclosingMountFinish :: FileClass file => file -> AsyncResult -> IO Mount -- | Gets the requested information about the files in a directory. The -- result is a GFileEnumerator object that will give out -- GFileInfo objects for all the files in the directory. -- -- The attribute value is a string that specifies the file attributes -- that should be gathered. It is not an error if it's not possible to -- read a particular requested attribute from a file - it just won't be -- set. attribute should be a comma-separated list of attribute or -- attribute wildcards. The wildcard "*" means all attributes, and a -- wildcard like "standard::*" means all attributes in the standard -- namespace. An example attribute query be "standard::*,user". -- The standard attributes are available as defines, like -- GFileAttributeStandardName. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will -- be returned. -- -- If the file does not exist, the GIoErrorNotFound error will -- be returned. If the file is not a directory, the -- GFileErrorNotdir error will be returned. Other errors are -- possible too. fileEnumerateChildren :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileEnumerator -- | Asynchronously gets the requested information about the files in a -- directory. The result is a GFileEnumerator object that will give out -- GFileInfo objects for all the files in the directory. -- -- For more details, see fileEnumerateChildren which is the -- synchronous version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileEnumerateChildrenFinish to get the result of the -- operation. fileEnumerateChildrenAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes an async enumerate children operation. See -- fileEnumerateChildrenAsync. fileEnumerateChildrenFinish :: FileClass file => file -> AsyncResult -> IO FileEnumerator -- | Renames file to the specified display name. -- -- The display name is converted from UTF8 to the correct encoding for -- the target filesystem if possible and the file is renamed to this. -- -- If you want to implement a rename operation in the user interface the -- edit name (GFileAttributeStandardEditName) should be used as the -- initial value in the rename widget, and then the result after editing -- should be passed to fileSetDisplayName. -- -- On success the resulting converted filename is returned. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileSetDisplayName :: FileClass file => file -> String -> Maybe Cancellable -> IO File -- | Asynchronously sets the display name for a given GFile. -- -- For more details, see fileSetDisplayName which is the -- synchronous version of this call. -- -- When the operation is finished, callback will be called. You can then -- call fileSetDisplayNameFinish to get the result of the -- operation. fileSetDisplayNameAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO () -- | Finishes setting a display name started with -- fileSetDisplayNameAsync. fileSetDisplayNameFinish :: FileClass file => file -> AsyncResult -> IO File -- | Deletes a file. If the file is a directory, it will only be deleted if -- it is empty. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileDelete :: FileClass file => file -> Maybe Cancellable -> IO () -- | Sends file to the Trashcan, if possible. This is similar to -- deleting it, but the user can recover it before emptying the trashcan. -- Not all file systems support trashing, so this call can return the -- GIoErrorNotSupported error. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileTrash :: FileClass file => file -> Maybe Cancellable -> IO () -- | Copies the file source to the location specified by destination. Can -- not handle recursive copies of directories. -- -- If the flag GFileCopyOverwrite is specified an already existing -- destination file is overwritten. -- -- If the flag GFileCopyNofollowSymlinks is specified then symlinks will -- be copied as symlinks, otherwise the target of the source symlink will -- be copied. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If progressCallback is not Nothing, then the operation -- can be monitored by setting this to a GFileProgressCallback function. -- progressCallbackData will be passed to this function. It is -- guaranteed that this callback will be called after all data has been -- transferred with the total number of bytes copied during the -- operation. -- -- If the source file does not exist then the GIoErrorNotFound error is -- returned, independent on the status of the destination. -- -- If GFileCopyOverwrite is not specified and the target exists, then the -- error GIoErrorExists is returned. -- -- If trying to overwrite a file over a directory the GIoErrorIsDirectory -- error is returned. If trying to overwrite a directory with a directory -- the GIoErrorWouldMerge error is returned. -- -- If the source is a directory and the target does not exist, or -- GFileCopyOverwrite is specified and the target is a file, then the -- GIoErrorWouldRecurse error is returned. -- -- If you are interested in copying the GFile object itself (not the -- on-disk file), see fileDup. fileCopy :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO Bool -- | Copies the file source to the location specified by destination -- asynchronously. For details of the behaviour, see fileCopy. -- -- If progressCallback is not Nothing, then that function -- that will be called just like in fileCopy, however the callback -- will run in the main loop, not in the thread that is doing the I/O -- operation. -- -- When the operation is finished, callback will be called. You can then -- call fileCopyFinish to get the result of the operation. fileCopyAsync :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Int -> Maybe Cancellable -> Maybe FileProgressCallback -> AsyncReadyCallback -> IO () -- | Finishes copying the file started with fileCopyAsync. fileCopyFinish :: FileClass file => file -> AsyncResult -> IO Bool -- | Tries to move the file or directory source to the location specified -- by destination. If native move operations are supported then this is -- used, otherwise a copy + delete fallback is used. The native -- implementation may support moving directories (for instance on moves -- inside the same filesystem), but the fallback code does not. -- -- If the flag GFileCopyOverwrite is specified an already existing -- destination file is overwritten. -- -- If the flag GFileCopyNofollowSymlinks is specified then symlinks will -- be copied as symlinks, otherwise the target of the source symlink will -- be copied. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. -- -- If progressCallback is not Nothing, then the operation -- can be monitored by setting this to a GFileProgressCallback function. -- progressCallbackData will be passed to this function. It is -- guaranteed that this callback will be called after all data has been -- transferred with the total number of bytes copied during the -- operation. -- -- If the source file does not exist then the GIoErrorNotFound error is -- returned, independent on the status of the destination. -- -- If GFileCopyOverwrite is not specified and the target exists, then the -- error GIoErrorExists is returned. -- -- If trying to overwrite a file over a directory the GIoErrorIsDirectory -- error is returned. If trying to overwrite a directory with a directory -- the GIoErrorWouldMerge error is returned. -- -- If the source is a directory and the target does not exist, or -- GFileCopyOverwrite is specified and the target is a file, then the -- GIoErrorWouldRecurse error may be returned (if the native move -- operation isn't available). fileMove :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO Bool -- | Creates a directory. Note that this will only create a child directory -- of the immediate parent directory of the path or URI given by the -- GFile. To recursively create directories, see -- fileMakeDirectoryWithParents. This function will fail if the -- parent directory does not exist, setting error to GIoErrorNotFound. If -- the file system doesn't support creating directories, this function -- will fail, setting error to GIoErrorNotSupported. -- -- For a local GFile the newly created directory will have the default -- (current) ownership and permissions of the current process. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileMakeDirectory :: FileClass file => file -> Maybe Cancellable -> IO () -- | Creates a directory and any parent directories that may not exist -- similar to 'mkdir -p'. If the file system does not support creating -- directories, this function will fail, setting error to -- GIoErrorNotSupported. -- -- For a local GFile the newly created directories will have the default -- (current) ownership and permissions of the current process. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileMakeDirectoryWithParents :: FileClass file => file -> Maybe Cancellable -> IO () -- | Creates a symbolic link. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileMakeSymbolicLink :: FileClass file => file -> String -> Maybe Cancellable -> IO () -- | Obtain the list of settable attributes for the file. -- -- Returns the type and full attribute name of all the attributes that -- can be set on this file. This doesn't mean setting it will always -- succeed though, you might get an access failure, or some specific file -- may not support a specific attribute. -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileQuerySettableAttributes :: FileClass file => file -> Maybe Cancellable -> IO [FileAttributeInfo] -- | Obtain the list of attribute namespaces where new attributes can be -- created by a user. An example of this is extended attributes (in the -- xattr namespace). -- -- If cancellable is not Nothing, then the operation can be -- cancelled by triggering the cancellable object from another thread. If -- the operation was cancelled, the error GIoErrorCancelled will be -- returned. fileQueryWritableNamespaces :: FileClass file => file -> Maybe Cancellable -> IO [FileAttributeInfo] instance Typeable FileType instance Typeable FilesystemPreviewType instance Typeable FileMonitorFlags instance Typeable FileCopyFlags instance Typeable FileCreateFlags instance Typeable FileQueryInfoFlags instance Eq FileType instance Ord FileType instance Bounded FileType instance Show FileType instance Eq FilesystemPreviewType instance Ord FilesystemPreviewType instance Bounded FilesystemPreviewType instance Show FilesystemPreviewType instance Eq FileMonitorFlags instance Ord FileMonitorFlags instance Bounded FileMonitorFlags instance Show FileMonitorFlags instance Eq FileCopyFlags instance Ord FileCopyFlags instance Bounded FileCopyFlags instance Show FileCopyFlags instance Eq FileCreateFlags instance Ord FileCreateFlags instance Bounded FileCreateFlags instance Show FileCreateFlags instance Eq FileQueryInfoFlags instance Ord FileQueryInfoFlags instance Bounded FileQueryInfoFlags instance Show FileQueryInfoFlags instance Eq File instance Enum FileType instance Enum FilesystemPreviewType instance Flags FileMonitorFlags instance Enum FileMonitorFlags instance Flags FileCopyFlags instance Enum FileCopyFlags instance Flags FileCreateFlags instance Enum FileCreateFlags instance Flags FileQueryInfoFlags instance Enum FileQueryInfoFlags module System.GIO.Async.Cancellable data Cancellable cancellableNew :: IO Cancellable cancellableIsCancelled :: Cancellable -> IO Bool cancellableThrowErrorIfCancelled :: Cancellable -> IO () cancellableGetCurrent :: IO (Maybe Cancellable) cancellablePopCurrent :: Maybe Cancellable -> IO () cancellablePushCurrent :: Maybe Cancellable -> IO () cancellableReset :: Cancellable -> IO () cancellableCancel :: Cancellable -> IO () cancellableCancelled :: Signal Cancellable (IO ()) module System.GIO.Async.AsyncResult data AsyncResult class GObjectClass o => AsyncResultClass o type AsyncReadyCallback = GObject -> AsyncResult -> IO () module System.GIO