gio-0.12.2: Binding to the GIO.

Portability | portable (depends on GHC)
Stability | alpha
Maintainer | gtk2hs-devel@lists.sourceforge.net

System.GIO.File.File

Contents

- Details
- Types.
- Enums
- Methods

Description

Synopsis

- newtype File = File (ForeignPtr File)
- class GObjectClass o => FileClass o
- type FileProgressCallback = Offset -> Offset -> IO ()
- type FileReadMoreCallback = ByteString -> IO Bool
- type Offset = CLLong
- data FileInputStream
- class InputStreamClass o => FileInputStreamClass o
- data FileOutputStream
- class OutputStreamClass o => FileOutputStreamClass o
- data InputStream
- class GObjectClass o => InputStreamClass o
- data OutputStream
- class GObjectClass o => OutputStreamClass o
- data BufferedInputStream
- class FilterInputStreamClass o => BufferedInputStreamClass o
- data BufferedOutputStream
- class FilterOutputStreamClass o => BufferedOutputStreamClass o
- data MemoryInputStream
- class InputStreamClass o => MemoryInputStreamClass o
- data MemoryOutputStream
- class OutputStreamClass o => MemoryOutputStreamClass o
- data FilterInputStream
- class InputStreamClass o => FilterInputStreamClass o
- data FilterOutputStream
- class OutputStreamClass o => FilterOutputStreamClass o
- data DataInputStream
- class BufferedInputStreamClass o => DataInputStreamClass o
- data DataOutputStream
- class FilterOutputStreamClass o => DataOutputStreamClass o
- data FileType
  - = FileTypeUnknown
  - | FileTypeRegular
  - | FileTypeDirectory
  - | FileTypeSymbolicLink
  - | FileTypeSpecial
  - | FileTypeShortcut
  - | FileTypeMountable
- data FileCopyFlags
  - = FileCopyNone
  - | FileCopyOverwrite
  - | FileCopyBackup
  - | FileCopyNofollowSymlinks
  - | FileCopyAllMetadata
  - | FileCopyNoFallbackForMove
  - | FileCopyTargetDefaultPerms
- data FileQueryInfoFlags
  - = FileQueryInfoNone
  - | FileQueryInfoNofollowSymlinks
- data FileCreateFlags
  - = FileCreateNone
  - | FileCreatePrivate
  - | FileCreateReplaceDestination
- data FileMonitorFlags
  - = FileMonitorNone
  - | FileMonitorWatchMounts
  - | FileMonitorSendMoved
- data MountMountFlags = MountMountNone
- data MountUnmountFlags
  - = MountUnmountNone
  - | MountUnmountForce
- fileFromPath :: ByteString -> File
- fileFromURI :: String -> File
- fileFromCommandlineArg :: ByteString -> File
- fileFromParseName :: String -> File
- fileEqual :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool
- fileBasename :: FileClass file => file -> ByteString
- filePath :: FileClass file => file -> ByteString
- fileHasParent :: FileClass file => file -> Maybe File -> Bool
- fileURI :: FileClass file => file -> String
- fileParseName :: FileClass file => file -> String
- fileGetChild :: FileClass file => file -> ByteString -> File
- fileGetChildForDisplayName :: FileClass file => file -> String -> File
- fileHasPrefix :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool
- fileGetRelativePath :: (FileClass file1, FileClass file2) => file1 -> file2 -> Maybe ByteString
- fileResolveRelativePath :: FileClass file => file -> ByteString -> Maybe File
- fileIsNative :: FileClass file => file -> Bool
- fileHasURIScheme :: FileClass file => file -> String -> Bool
- fileURIScheme :: FileClass file => file -> String
- fileRead :: FileClass file => file -> Maybe Cancellable -> IO FileInputStream
- fileReadAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileReadFinish :: FileClass file => file -> AsyncResult -> IO FileInputStream
- fileAppendTo :: FileClass file => file -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream
- fileCreate :: FileClass file => file -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream
- fileReplace :: FileClass file => file -> Maybe String -> Bool -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream
- fileAppendToAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileAppendToFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream
- fileCreateAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileCreateFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream
- fileReplaceAsync :: FileClass file => file -> String -> Bool -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileReplaceFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream
- fileQueryInfo :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileInfo
- fileQueryInfoAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileQueryInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo
- fileQueryExists :: FileClass file => file -> Maybe Cancellable -> Bool
- fileQueryFileType :: FileClass file => file -> [FileQueryInfoFlags] -> Maybe Cancellable -> FileType
- fileQueryFilesystemInfo :: FileClass file => file -> String -> Maybe Cancellable -> IO FileInfo
- fileQueryFilesystemInfoAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileQueryFilesystemInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo
- fileQueryDefaultHandler :: FileClass file => file -> Maybe Cancellable -> IO AppInfo
- fileFindEnclosingMount :: FileClass file => file -> Maybe Cancellable -> IO Mount
- fileFindEnclosingMountAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileFindEnclosingMountFinish :: FileClass file => file -> AsyncResult -> IO Mount
- fileEnumerateChildren :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileEnumerator
- fileEnumerateChildrenAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileEnumerateChildrenFinish :: FileClass file => file -> AsyncResult -> IO FileEnumerator
- fileSetDisplayName :: FileClass file => file -> String -> Maybe Cancellable -> IO File
- fileSetDisplayNameAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileSetDisplayNameFinish :: FileClass file => file -> AsyncResult -> IO File
- fileDelete :: FileClass file => file -> Maybe Cancellable -> IO ()
- fileTrash :: FileClass file => file -> Maybe Cancellable -> IO ()
- fileCopy :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO ()
- fileCopyAsync :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Int -> Maybe Cancellable -> Maybe FileProgressCallback -> AsyncReadyCallback -> IO ()
- fileCopyFinish :: FileClass file => file -> AsyncResult -> IO ()
- fileMove :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO ()
- fileMakeDirectory :: FileClass file => file -> Maybe Cancellable -> IO ()
- fileMakeDirectoryWithParents :: FileClass file => file -> Maybe Cancellable -> IO ()
- fileMakeSymbolicLink :: FileClass file => file -> ByteString -> Maybe Cancellable -> IO ()
- fileQuerySettableAttributes :: FileClass file => file -> Maybe Cancellable -> IO [FileAttributeInfo]
- fileQueryWritableNamespaces :: FileClass file => file -> Maybe Cancellable -> IO [FileAttributeInfo]
- fileSetAttributesFromInfo :: FileClass file => file -> FileInfo -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributesFromInfoAsync :: FileClass file => file -> FileInfo -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileSetAttributesFinish :: FileClass file => file -> AsyncResult -> FileInfo -> IO ()
- fileSetAttributeString :: FileClass file => file -> String -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributeByteString :: FileClass file => file -> String -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributeWord32 :: FileClass file => file -> String -> Word32 -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributeInt32 :: FileClass file => file -> String -> Int32 -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributeWord64 :: FileClass file => file -> String -> Word64 -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileSetAttributeInt64 :: FileClass file => file -> String -> Int64 -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO ()
- fileCopyAttributes :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> IO ()
- fileMonitorDirectory :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor
- fileMonitorFile :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor
- fileMonitor :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor
- fileMountMountable :: FileClass file => file -> [MountMountFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileMountMountableFinish :: FileClass file => file -> AsyncResult -> IO File
- fileUnmountMountableWithOperation :: FileClass file => file -> [MountUnmountFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileUnmountMountableWithOperationFinish :: FileClass file => file -> AsyncResult -> IO ()
- fileEjectMountableWithOperation :: FileClass file => file -> [MountUnmountFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileEjectMountableWithOperationFinish :: FileClass file => file -> AsyncResult -> IO ()
- fileStartMountable :: FileClass file => file -> [DriveStartFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileStartMountableFinish :: FileClass file => file -> AsyncResult -> IO ()
- fileStopMountable :: FileClass file => file -> [MountUnmountFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileStopMountableFinish :: FileClass file => file -> AsyncResult -> IO ()
- filePollMountable :: FileClass file => file -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- filePollMountableFinish :: FileClass file => file -> AsyncResult -> IO Bool
- fileMountEnclosingVolume :: FileClass file => file -> [MountMountFlags] -> Maybe MountOperation -> Maybe Cancellable -> AsyncReadyCallback -> IO ()
- fileMountEnclosingVolumeFinish :: FileClass file => file -> AsyncResult -> IO Bool
- fileSupportsThreadContexts :: FileClass file => file -> IO Bool

# Details

`File` is a high level abstraction for manipulating files on a virtual file system. `File`s are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that `File` objects do not represent files, merely an identifier for a file. All file content I/O is implemented as streaming operations (see GInputStream and GOutputStream).

To construct a `File`, you can use: `fileFromPath` if you have a URI. `fileNewForCommandlineArg` from a utf8 string gotten from `fileGetParseName`.

One way to think of a `File` is as an abstraction of a pathname. For normal files the system pathname is what is stored internally, but as `File`s are extensible it could also be something else that corresponds to a pathname in a userspace implementation of a filesystem.

`File`s make up hierarchies of directories and files that correspond to the files on a filesystem. You can move through the file system with `File` using `fileGetParent` to get an identifier for the parent directory, `fileGetChild` to get a child within a directory, `fileResolveRelativePath` to resolve a relative path between two `File`s. There can be multiple hierarchies, so you may not end up at the same root if you repeatedly call `fileGetParent` on two different files.

All `File`s have a basename (get with `fileGetBasename`. These names are byte strings that are used to identify the file on the filesystem (relative to its parent directory) and there is no guarantees that they have any particular charset encoding or even make any sense at all. If you want to use filenames in a user interface you should use the display name that you can get by requesting the `FileAttributeStandardDisplayName` attribute with `fileQueryInfo`. This is guaranteed to be in utf8 and can be used in a user interface. But always store the real basename or the `File` to use to actually access the file, because there is no way to go from a display name to the actual name.

Using `File` as an identifier has the same weaknesses as using a path in that there may be multiple aliases for the same file. For instance, hard or soft links may cause two different `File`s to refer to the same file. Other possible causes for aliases are: case insensitive filesystems, short and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if two `File`s point to the same file you can query for the `FileAttributeIdFile` attribute. Note that `File` does some trivial canonicalization of pathnames passed in, so that trivial differences in the path string used at creation (duplicated slashes, slash at end of path, . or .. path segments, etc) does not create different `File`s.

Many `File` operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous functions simply have _async() appended to their function names. The asynchronous I/O functions call a `AsyncReadyCallback` which is then used to finalize the operation, producing a `AsyncResult` which is then passed to the function's matching _finish() operation.

Some `File` operations do not have synchronous analogs, as they may take a very long time to finish, and blocking may leave an application unusable. Notable cases include: `fileMountMountable` to mount a mountable file. `fileUnmountMountableWithOperation` to unmount a mountable file. `fileEjectMountableWithOperation` to eject a mountable file.

One notable feature of `File`s are entity tags, or etags for short. Entity tags are somewhat like a more abstract version of the traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system. See the HTTP 1.1 specification for HTTP Etag headers, which are a very similar concept.

# Types.

newtype File

Constructors

File (ForeignPtr File) |

Instances

Eq File |
GObjectClass File |
FileClass File |

class GObjectClass o => FileClass o

Instances

FileClass File |

type FileProgressCallback = Offset -> Offset -> IO ()

type FileReadMoreCallback = ByteString -> IO Bool

type Offset = CLLong

data FileInputStream

Instances

Eq FileInputStream |
Ord FileInputStream |
GObjectClass FileInputStream |
FileInputStreamClass FileInputStream |
InputStreamClass FileInputStream |

class InputStreamClass o => FileInputStreamClass o

Instances

FileInputStreamClass FileInputStream |

data FileOutputStream

Instances

Eq FileOutputStream |
Ord FileOutputStream |
GObjectClass FileOutputStream |
FileOutputStreamClass FileOutputStream |
OutputStreamClass FileOutputStream |

class OutputStreamClass o => FileOutputStreamClass o

Instances

FileOutputStreamClass FileOutputStream |

data InputStream

Instances

Eq InputStream |
Ord InputStream |
GObjectClass InputStream |
InputStreamClass InputStream |

class GObjectClass o => InputStreamClass o

Instances

InputStreamClass FileInputStream |
InputStreamClass DataInputStream |
InputStreamClass BufferedInputStream |
InputStreamClass FilterInputStream |
InputStreamClass MemoryInputStream |
InputStreamClass InputStream |

data OutputStream

Instances

Eq OutputStream |
Ord OutputStream |
GObjectClass OutputStream |
OutputStreamClass OutputStream |

class GObjectClass o => OutputStreamClass o

Instances

OutputStreamClass MemoryOutputStream |
OutputStreamClass FileOutputStream |
OutputStreamClass BufferedOutputStream |
OutputStreamClass DataOutputStream |
OutputStreamClass FilterOutputStream |
OutputStreamClass OutputStream |

data BufferedInputStream

Instances

Eq BufferedInputStream |
Ord BufferedInputStream |
GObjectClass BufferedInputStream |
BufferedInputStreamClass BufferedInputStream |
FilterInputStreamClass BufferedInputStream |
InputStreamClass BufferedInputStream |

class FilterInputStreamClass o => BufferedInputStreamClass o

Instances

BufferedInputStreamClass DataInputStream |
BufferedInputStreamClass BufferedInputStream |

data BufferedOutputStream

Instances

Eq BufferedOutputStream |
Ord BufferedOutputStream |
GObjectClass BufferedOutputStream |
BufferedOutputStreamClass BufferedOutputStream |
FilterOutputStreamClass BufferedOutputStream |
OutputStreamClass BufferedOutputStream |

class FilterOutputStreamClass o => BufferedOutputStreamClass o

Instances

BufferedOutputStreamClass BufferedOutputStream |

data MemoryInputStream

Instances

Eq MemoryInputStream |
Ord MemoryInputStream |
GObjectClass MemoryInputStream |
MemoryInputStreamClass MemoryInputStream |
InputStreamClass MemoryInputStream |

class InputStreamClass o => MemoryInputStreamClass o

Instances

MemoryInputStreamClass MemoryInputStream |

data MemoryOutputStream

Instances

Eq MemoryOutputStream |
Ord MemoryOutputStream |
GObjectClass MemoryOutputStream |
MemoryOutputStreamClass MemoryOutputStream |
OutputStreamClass MemoryOutputStream |

class OutputStreamClass o => MemoryOutputStreamClass o

Instances

MemoryOutputStreamClass MemoryOutputStream |

data FilterInputStream

Instances

Eq FilterInputStream |
Ord FilterInputStream |
GObjectClass FilterInputStream |
FilterInputStreamClass FilterInputStream |
InputStreamClass FilterInputStream |

class InputStreamClass o => FilterInputStreamClass o

Instances

FilterInputStreamClass DataInputStream |
FilterInputStreamClass BufferedInputStream |
FilterInputStreamClass FilterInputStream |

data FilterOutputStream

Instances

Eq FilterOutputStream |
Ord FilterOutputStream |
GObjectClass FilterOutputStream |
FilterOutputStreamClass FilterOutputStream |
OutputStreamClass FilterOutputStream |

class OutputStreamClass o => FilterOutputStreamClass o

Instances

FilterOutputStreamClass BufferedOutputStream |
FilterOutputStreamClass DataOutputStream |
FilterOutputStreamClass FilterOutputStream |

data DataInputStream

Instances

Eq DataInputStream |
Ord DataInputStream |
GObjectClass DataInputStream |
DataInputStreamClass DataInputStream |
BufferedInputStreamClass DataInputStream |
FilterInputStreamClass DataInputStream |
InputStreamClass DataInputStream |

class BufferedInputStreamClass o => DataInputStreamClass o

Instances

DataInputStreamClass DataInputStream |

data DataOutputStream

Instances

Eq DataOutputStream |
Ord DataOutputStream |
GObjectClass DataOutputStream |
DataOutputStreamClass DataOutputStream |
FilterOutputStreamClass DataOutputStream |
OutputStreamClass DataOutputStream |

class FilterOutputStreamClass o => DataOutputStreamClass o

Instances

DataOutputStreamClass DataOutputStream |

# Enums

data FileType

Indicates the file's on-disk type.

Constructors

FileTypeUnknown |
FileTypeRegular |
FileTypeDirectory |
FileTypeSymbolicLink |
FileTypeSpecial |
FileTypeShortcut |
FileTypeMountable |

Instances

Bounded FileType |
Enum FileType |
Eq FileType |
Ord FileType |
Show FileType |
Typeable FileType |

data FileCopyFlags

Flags used when copying or moving files.

Constructors

FileCopyNone |
FileCopyOverwrite |
FileCopyBackup |
FileCopyNofollowSymlinks |
FileCopyAllMetadata |
FileCopyNoFallbackForMove |
FileCopyTargetDefaultPerms |

Instances

Bounded FileCopyFlags |
Enum FileCopyFlags |
Eq FileCopyFlags |
Ord FileCopyFlags |
Show FileCopyFlags |
Typeable FileCopyFlags |
Flags FileCopyFlags |

data FileQueryInfoFlags

Flags used when querying a `FileInfo`.

Constructors

FileQueryInfoNone |
FileQueryInfoNofollowSymlinks |

Instances

Bounded FileQueryInfoFlags |
Enum FileQueryInfoFlags | Flags used when an operation may create a file.
Eq FileQueryInfoFlags |
Ord FileQueryInfoFlags |
Show FileQueryInfoFlags |
Typeable FileQueryInfoFlags |
Flags FileQueryInfoFlags |

data FileCreateFlags

Constructors

FileCreateNone |
FileCreatePrivate |
FileCreateReplaceDestination |

Instances

Bounded FileCreateFlags |
Enum FileCreateFlags |
Eq FileCreateFlags |
Ord FileCreateFlags |
Show FileCreateFlags |
Typeable FileCreateFlags |
Flags FileCreateFlags |

data FileMonitorFlags

Flags used to set what a `FileMonitor` will watch for.

Constructors

FileMonitorNone |
FileMonitorWatchMounts |
FileMonitorSendMoved |

Instances

Bounded FileMonitorFlags |
Enum FileMonitorFlags | Indicates a hint from the file system whether files should be previewed in a file manager. Returned as the value of the key `FileAttributeFilesystemUsePreview`.
Eq FileMonitorFlags |
Ord FileMonitorFlags |
Show FileMonitorFlags |
Typeable FileMonitorFlags |
Flags FileMonitorFlags |

data MountMountFlags

Flags used when mounting a mount.

Constructors

MountMountNone |

Instances

Bounded MountMountFlags |
Enum MountMountFlags |
Eq MountMountFlags |
Ord MountMountFlags |
Show MountMountFlags |
Typeable MountMountFlags |
Flags MountMountFlags |

data MountUnmountFlags

Flags used when an unmounting a mount.

Constructors

MountUnmountNone |
MountUnmountForce |

Instances

Bounded MountUnmountFlags |
Enum MountUnmountFlags |
Eq MountUnmountFlags |
Ord MountUnmountFlags |
Show MountUnmountFlags |
Typeable MountUnmountFlags |
Flags MountUnmountFlags |

# Methods

fileFromPath :: ByteString -> File

Constructs a `File` for a given path. This operation never fails, but the returned object might not support any I/O operation if path is malformed.

fileFromURI :: String -> File

Constructs a `File` 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.

fileFromCommandlineArg :: ByteString -> File

Creates a `File` 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.

fileFromParseName :: String -> File

Constructs a `File` with the given name (i.e. something given by `fileParseName`. This operation never fails, but the returned object might not support any I/O operation if the `parseName` cannot be parsed.

fileEqual :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool

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.

fileBasename :: FileClass file => file -> ByteString

Gets the base name (the last component of the path) for a given `File`.

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 `FileAttributeStandardDisplayName` attribute with `fileQueryInfo`.

This call does no blocking i/o.

filePath :: FileClass file => file -> ByteString

Gets the local pathname for `File`, if one exists.

This call does no blocking i/o.

fileHasParent :: FileClass file => file -> Maybe File -> Bool

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.

fileURI :: FileClass file => file -> String

Gets the URI for the file.

This call does no blocking i/o.

fileParseName :: 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 `File` back using `fileParseName`.

This is generally used to show the `File` 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.

fileGetChild :: FileClass file => file -> ByteString -> File

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 `File` that points to it. You can use this for instance to create that file.

This call does no blocking i/o.

fileGetChildForDisplayName :: 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 throws a GError. This is very useful when constructing a `File` 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.

fileHasPrefix :: (FileClass file1, FileClass file2) => file1 -> file2 -> Bool

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.

fileGetRelativePath :: (FileClass file1, FileClass file2) => file1 -> file2 -> Maybe ByteString

Gets the path for descendant relative to parent.

This call does no blocking i/o.

fileResolveRelativePath :: FileClass file => file -> ByteString -> Maybe File

Resolves a relative path for file to an absolute path.

This call does no blocking i/o.

fileIsNative :: FileClass file => file -> Bool

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.

fileHasURIScheme :: FileClass file => file -> String -> Bool

Checks to see if a `File` has a given URI scheme.

This call does no blocking i/o.

fileURIScheme :: FileClass file => file -> String

Gets the URI scheme for a `File`. 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.

fileRead :: FileClass file => file -> Maybe Cancellable -> IO FileInputStream

Opens a file for reading. The result is a `FileInputStream` 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 `IoErrorCancelled` will be returned.

If the file does not exist, the `IoErrorNotFound` error will be returned. If the file is a directory, the `IoErrorIsDirectory` error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

fileReadAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

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.

fileReadFinish :: FileClass file => file -> AsyncResult -> IO FileInputStream

Finishes an asynchronous file read operation started with `fileReadAsync`.

fileAppendTo :: FileClass file => file -> [FileCreateFlags] -> Maybe Cancellable -> IO FileOutputStream

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 `FileCreatePrivate` 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 `IoErrorCancelled` will be returned.

Some file systems don't allow all file names, and may return an `IoErrorInvalidFilename` error. If the file is a directory the `IoErrorIsDirectory` error 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

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 `FileCreatePrivate` 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 `IoErrorCancelled` will be returned.

If a file or directory with this name already exists the `IoErrorExists` error will be returned. Some file systems don't allow all file names, and may return an `IoErrorInvalidFilename` error, and if the name is to long `IoErrorFilenameTooLong` 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

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 `FileCreatePrivate` 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 `IoErrorCancelled` 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 `IoErrorWrongEtag` 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 `FileOutputStream`. 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 `IoErrorCantCreateBackup` error will be returned. If you want to replace anyway, try again with `makeBackup` set to `False`.

If the file is a directory the `IoErrorIsDirectory` error will be returned, and if the file is some other form of non-regular file then a `IoErrorNotRegularFile` error will be returned. Some file systems don't allow all file names, and may return an `IoErrorInvalidFilename` error, and if the name is to long `IoErrorFilenameTooLong` will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

fileAppendToAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

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.

fileAppendToFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream

Finishes an asynchronous file append operation started with `fileAppendToAsync`.

fileCreateAsync :: FileClass file => file -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

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.

fileCreateFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream

Finishes an asynchronous file create operation started with `fileCreateAsync`.

fileReplaceAsync :: FileClass file => file -> String -> Bool -> [FileCreateFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

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.

fileReplaceFinish :: FileClass file => file -> AsyncResult -> IO FileOutputStream

Finishes an asynchronous file replace operation started with `fileReplaceAsync`.

fileQueryInfo :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileInfo

Gets the requested information about specified file. The result is a `FileInfo` 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 `FileAttributeStandardName`.

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 `IoErrorCancelled` 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 `FileQueryInfoNofollowSymlinks` 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 `IoErrorNotFound` error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

fileQueryInfoAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

Asynchronously gets the requested information about specified file. The result is a `FileInfo` 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.

fileQueryInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo

Finishes an asynchronous file info query. See `fileQueryInfoAsync`.

fileQueryExists :: FileClass file => file -> Maybe Cancellable -> Bool

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 `IoErrorExists` 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.

fileQueryFileType :: FileClass file => file -> [FileQueryInfoFlags] -> Maybe Cancellable -> FileType

Utility function to inspect the `FileType` 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.

fileQueryFilesystemInfo :: FileClass file => file -> String -> Maybe Cancellable -> IO FileInfo

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 `FileAttributeFilesystemType` (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 `IoErrorCancelled` will be returned.

If the file does not exist, the `IoErrorNotFound` error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

fileQueryFilesystemInfoAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

Asynchronously gets the requested information about the filesystem that the specified file is on. The result is a `FileInfo` 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.

fileQueryFilesystemInfoFinish :: FileClass file => file -> AsyncResult -> IO FileInfo

Finishes an asynchronous filesystem info query. See `fileQueryFilesystemInfoAsync`.

fileQueryDefaultHandler :: FileClass file => file -> Maybe Cancellable -> IO AppInfo

Returns the `AppInfo` 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 `IoErrorCancelled` will be returned.

fileFindEnclosingMount :: FileClass file => file -> Maybe Cancellable -> IO Mount

Gets a `Mount` for the `File`.

If the `FileIface` for file does not have a mount (e.g. possibly a remote share), error will be set to `IoErrorNotFound` 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 `IoErrorCancelled` will be returned.

fileFindEnclosingMountAsync :: FileClass file => file -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

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.

fileFindEnclosingMountFinish :: FileClass file => file -> AsyncResult -> IO Mount

Finishes an asynchronous find mount request. See `fileFindEnclosingMountAsync`.

fileEnumerateChildren :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Maybe Cancellable -> IO FileEnumerator

Gets the requested information about the files in a directory. The result is a `FileEnumerator` object that will give out `FileInfo` 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 `FileAttributeStandardName`.

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 `IoErrorCancelled` will be returned.

If the file does not exist, the `IoErrorNotFound` error will be returned. If the file is not a directory, the `FileErrorNotdir` error will be returned. Other errors are possible too.

fileEnumerateChildrenAsync :: FileClass file => file -> String -> [FileQueryInfoFlags] -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

Asynchronously gets the requested information about the files in a directory. The result is a `FileEnumerator` object that will give out `FileInfo` 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.

fileEnumerateChildrenFinish :: FileClass file => file -> AsyncResult -> IO FileEnumerator

Finishes an async enumerate children operation. See `fileEnumerateChildrenAsync`.

fileSetDisplayName :: FileClass file => file -> String -> Maybe Cancellable -> IO File

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 (`FileAttributeStandardEditName`) 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 `IoErrorCancelled` will be returned.

fileSetDisplayNameAsync :: FileClass file => file -> String -> Int -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

Asynchronously sets the display name for a given `File`.

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.

fileSetDisplayNameFinish :: FileClass file => file -> AsyncResult -> IO File

Finishes setting a display name started with `fileSetDisplayNameAsync`.

fileDelete :: FileClass file => file -> Maybe Cancellable -> IO ()

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 `IoErrorCancelled` will be returned.

fileTrash :: 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 `IoErrorNotSupported` 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 `IoErrorCancelled` will be returned.

fileCopy :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO ()

Copies the file source to the location specified by destination. Can not handle recursive copies of directories.

If the flag `FileCopyOverwrite` is specified an already existing destination file is overwritten.

If the flag `FileCopyNofollowSymlinks` 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 `IoErrorCancelled` will be returned.

If `progressCallback` is not `Nothing`, then the operation can be monitored by setting this to a `FileProgressCallback` 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 `IoErrorNotFound` error is returned, independent on the status of the destination.

If `FileCopyOverwrite` is not specified and the target exists, then the error `IoErrorExists` is returned.

If trying to overwrite a file over a directory the `IoErrorIsDirectory` error is returned. If trying to overwrite a directory with a directory the `IoErrorWouldMerge` error is returned.

If the source is a directory and the target does not exist, or `FileCopyOverwrite` is specified and the target is a file, then the `IoErrorWouldRecurse` error is returned.

If you are interested in copying the `File` object itself (not the on-disk file), see `fileDup`.

fileCopyAsync :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Int -> Maybe Cancellable -> Maybe FileProgressCallback -> AsyncReadyCallback -> IO ()

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.

fileCopyFinish :: FileClass file => file -> AsyncResult -> IO ()

Finishes copying the file started with `fileCopyAsync`.

Throws a `GError` if an error occurs.

fileMove :: (FileClass source, FileClass destination) => source -> destination -> [FileCopyFlags] -> Maybe Cancellable -> Maybe FileProgressCallback -> IO ()

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 `FileCopyOverwrite` is specified an already existing destination file is overwritten.

If the flag `FileCopyNofollowSymlinks` 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 `IoErrorCancelled` will be returned.

If `progressCallback` is not `Nothing`, then the operation can be monitored by setting this to a `FileProgressCallback` 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 `IoErrorNotFound` error is returned, independent on the status of the destination.

If `FileCopyOverwrite` is not specified and the target exists, then the error `IoErrorExists` is returned.

If trying to overwrite a file over a directory the `IoErrorIsDirectory` error is returned. If trying to overwrite a directory with a directory the `IoErrorWouldMerge` error is returned.

If the source is a directory and the target does not exist, or `FileCopyOverwrite` is specified and the target is a file, then the `IoErrorWouldRecurse` error may be returned (if the native move operation isn't available).

fileMakeDirectory :: FileClass file => file -> Maybe Cancellable -> IO ()

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 `File`. To recursively create directories, see `fileMakeDirectoryWithParents`. This function will fail if the parent directory does not exist, setting error to `IoErrorNotFound`. If the file system doesn't support creating directories, this function will fail, setting error to `IoErrorNotSupported`.

For a local `File` 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 `IoErrorCancelled` will be returned.

fileMakeDirectoryWithParents :: 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 `IoErrorNotSupported`.

For a local `File` 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 `IoErrorCancelled` will be returned.

fileMakeSymbolicLink :: FileClass file => file -> ByteString -> 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 `IoErrorCancelled` will be returned.

fileQuerySettableAttributes :: FileClass file => file -> Maybe Cancellable -> IO [FileAttributeInfo]

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 `IoErrorCancelled` will be returned.

fileQueryWritableNamespaces :: 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 `IoErrorCancelled` will be returned.

fileSetAttributesFromInfo

Arguments

:: FileClass file |
=> file |
-> FileInfo |
-> [FileQueryInfoFlags] |
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Tries to set all attributes in the `FileInfo` on the target values, not stopping on the first error.

If there is any error during this operation then error will be set to the first error. Error on particular fields are flagged by setting the status field in the attribute value to `FileAttributeStatusErrorSetting`, which means you can also detect further errors.

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 `IoErrorCancelled` will be returned.

fileSetAttributesFromInfoAsync

Arguments

:: FileClass file |
=> file |
-> FileInfo |
-> [FileQueryInfoFlags] |
-> Int | `ioPriority` the I/O priority of the request.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback |
-> IO () | returns `True` if there was any error, `False` otherwise.

Asynchronously sets the attributes of file with info.

For more details, see `fileSetAttributesFromInfo` which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call `fileSetAttributesFinish` to get the result of the operation.

fileSetAttributesFinish :: FileClass file => file -> AsyncResult -> FileInfo -> IO ()

Finishes setting an attribute started in `fileSetAttributesAsync`.

Throws a `GError` if an error occurs.

fileSetAttributeString

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> String | `value` a string containing the attribute's value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeString` to value. If attribute is of a different type, this operation will fail.

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 `IoErrorCancelled` will be returned.

fileSetAttributeByteString

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> String | `value` a string containing the attribute's value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeByteString` to value. If attribute is of a different type, this operation will fail, returning `False`.

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 `IoErrorCancelled` will be returned.

fileSetAttributeWord32

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> Word32 | `value` a Word32 containing the attribute's new value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeUint32` to value. If attribute is of a different type, this operation will fail.

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 `IoErrorCancelled` will be returned.

fileSetAttributeInt32

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> Int32 | `value` a Int32 containing the attribute's new value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeInt32` to value. If attribute is of a different type, this operation will fail.

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 `IoErrorCancelled` will be returned.

fileSetAttributeWord64

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> Word64 | `value` a Word64 containing the attribute's new value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeUint64` to value. If attribute is of a different type, this operation will fail.

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 `IoErrorCancelled` will be returned.

fileSetAttributeInt64

Arguments

:: FileClass file |
=> file |
-> String | `attribute` a string containing the attribute's name.
-> Int64 | `value` a Int64 containing the attribute's new value.
-> [FileQueryInfoFlags] | `flags` `FileQueryInfoFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Sets attribute of type `FileAttributeTypeInt64` to value. If attribute is of a different type, this operation will fail.

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 `IoErrorCancelled` will be returned.

fileCopyAttributes

Arguments

:: (FileClass source, FileClass destination) |
=> source | `source` a `File` with attributes.
-> destination | `destination` a `File` to copy attributes to.
-> [FileCopyFlags] | `flags` a set of `FileCopyFlags`.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> IO () |

Copies the file attributes from source to destination.

Normally only a subset of the file attributes are copied, those that are copies in a normal file copy operation (which for instance does not include e.g. owner). However if `FileCopyAllMetadata` is specified in flags, then all the metadata that is possible to copy is copied. This is useful when implementing move by copy + delete source.

fileMonitorDirectory :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor

Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported.

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 `IoErrorCancelled` will be returned.

fileMonitorFile :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor

Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used.

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 `IoErrorCancelled` will be returned.

fileMonitor :: FileClass file => file -> [FileMonitorFlags] -> Maybe Cancellable -> IO FileMonitor

Obtains a file or directory monitor for the given file, depending on the type 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 `IoErrorCancelled` will be returned.

fileMountMountable

Arguments

:: FileClass file |
=> file |
-> [MountMountFlags] | `flags` flags affecting the operation
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Mounts a file of type `FileTypeMountable`. Using `mountOperation`, you can request callbacks when, for instance, passwords are needed during authentication.

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 `IoErrorCancelled` will be returned.

When the operation is finished, callback will be called. You can then call `fileMountMountableFinish` to get the result of the operation.

fileMountMountableFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`
-> IO File |

Finishes a mount operation. See `fileMountMountable` for details.

Finish an asynchronous mount operation that was started with `fileMountMountable`.

fileUnmountMountableWithOperation

Arguments

:: FileClass file |
=> file |
-> [MountUnmountFlags] | `flags` flags affecting the operation
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Unmounts a file of type `FileTypeMountable`.

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 `IoErrorCancelled` will be returned.

When the operation is finished, callback will be called. You can then call `fileUnmountMountableFinish` to get the result of the operation.

fileUnmountMountableWithOperationFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`
-> IO () |

Finishes an unmount operation, see `fileUnmountMountableWithOperation` for details.

Finish an asynchronous unmount operation that was started with `fileUnmountMountableWithOperation`.

Throws a `GError` if an error occurs.

fileEjectMountableWithOperation

Arguments

:: FileClass file |
=> file |
-> [MountUnmountFlags] | `flags` flags affecting the operation
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Starts an asynchronous eject on a mountable. When this operation has completed, callback will be called with `userUser` data, and the operation can be finalized with `fileEjectMountableWithOperationFinish`.

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 `IoErrorCancelled` will be returned.

fileEjectMountableWithOperationFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`
-> IO () |

Finishes an asynchronous eject operation started by `fileEjectMountableWithOperation`.

Throws a `GError` if an error occurs.

fileStartMountable

Arguments

:: FileClass file |
=> file |
-> [DriveStartFlags] | `flags` flags affecting the start operation.
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Starts a file of type `FileTypeMountable`. Using `startOperation`, you can request callbacks when, for instance, passwords are needed during authentication.

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 `IoErrorCancelled` will be returned.

When the operation is finished, callback will be called. You can then call `fileMountMountableFinish` to get the result of the operation.

fileStartMountableFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`.
-> IO () |

Finishes a start operation. See `fileStartMountable` for details.

Finish an asynchronous start operation that was started with `fileStartMountable`.

Throws a `GError` if an error occurs.

fileStopMountable

Arguments

:: FileClass file |
=> file |
-> [MountUnmountFlags] | `flags` flags affecting the stop operation.
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Stops a file of type `FileTypeMountable`.

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 `IoErrorCancelled` will be returned.

When the operation is finished, callback will be called. You can then call `fileStopMountableFinish` to get the result of the operation.

fileStopMountableFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`.
-> IO () |

Finishes a stop operation. See `fileStopMountable` for details.

Finish an asynchronous stop operation that was stoped with `fileStopMountable`.

Throws a `GError` if an error occurs.

filePollMountable :: FileClass file => file -> Maybe Cancellable -> AsyncReadyCallback -> IO ()

Polls a file of type `FileTypeMountable`.

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 `IoErrorCancelled` will be returned.

When the operation is finished, callback will be called. You can then call `fileMountMountableFinish` to get the result of the operation.

filePollMountableFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`.
-> IO Bool | returns `True` if the file was successfully ejected. `False` otherwise.

Finishes a poll operation. See `filePollMountable` for details.

Finish an asynchronous poll operation that was polled with `filePollMountable`.

fileMountEnclosingVolume

Arguments

:: FileClass file |
=> file |
-> [MountMountFlags] | `flags` flags affecting the operation
-> Maybe MountOperation | `mountOperation` a `MountOperation` or `Nothing` to avoid user interaction.
-> Maybe Cancellable | `cancellable` optional `Cancellable` object, `Nothing` to ignore.
-> AsyncReadyCallback | `callback` a `AsyncReadyCallback`
-> IO () |

Starts a `mountOperation`, mounting the volume that contains the file location.

When this operation has completed, callback will be called with `userUser` data, and the operation can be finalized with `fileMountEnclosingVolumeFinish`.

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 `IoErrorCancelled` will be returned.

fileMountEnclosingVolumeFinish

Arguments

:: FileClass file |
=> file |
-> AsyncResult | `result` a `AsyncResult`.
-> IO Bool | returns `True` if the file was successfully ejected. `False` otherwise.

Finishes a mount operation started by `fileMountEnclosingVolume`.

fileSupportsThreadContexts

Arguments

:: FileClass file |
=> file |
-> IO Bool | returns Whether or not file supports thread-default contexts.

Checks if file supports thread-default contexts. If this returns `False`, you cannot perform asynchronous operations on file in a thread that has a thread-default context.