FileIF

GFile is a high level abstraction for manipulating files on a virtual file system. GFiles are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that GFile 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 GFile, you can use: - g_file_new_for_path() if you have a path. - g_file_new_for_uri() if you have a URI. - g_file_new_for_commandline_arg() for a command line argument. - g_file_new_tmp() to create a temporary file from a template. - g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name(). - g_file_new_build_filename() to create a file from path elements.

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

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

All GFiles have a basename (get with g_file_get_basename()). 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 G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). This is guaranteed to be in UTF-8 and can be used in a user interface. But always store the real basename or the GFile to use to actually access the file, because there is no way to go from a display name to the actual name.

Using GFile 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 GFiles 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 GFiles point to the same file you can query for the G_FILE_ATTRIBUTE_ID_FILE attribute. Note that GFile 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 GFiles

Many GFile 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 GAsyncReadyCallback which is then used to finalize the operation, producing a GAsyncResult which is then passed to the function's matching _finish() operation.

It is highly recommended to use asynchronous calls when running within a shared main loop, such as in the main thread of an application. This avoids I/O operations blocking other sources on the main loop from being dispatched. Synchronous I/O operations should be performed from worker threads. See the [introduction to asynchronous programming section][async-programming] for more.

Some GFile operations almost always take a noticeable amount of time, and so do not have synchronous analogs. Notable cases include: - g_file_mount_mountable() to mount a mountable file. - g_file_unmount_mountable_with_operation() to unmount a mountable file. - g_file_eject_mountable_with_operation() to eject a mountable file.

Entity Tags # {[gfile-etag|gfile-etag]}

One notable feature of GFiles 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.

interface FileIF {}

Members

Functions

appendTo
FileOutputStream appendTo(GFileCreateFlags flags, Cancellable cancellable)

Gets an output stream for appending data to the file. If the file doesn't already exist it is created.

appendToAsync
void appendToAsync(GFileCreateFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously opens file for appending.

appendToFinish
FileOutputStream appendToFinish(AsyncResultIF res)

Finishes an asynchronous file append operation started with g_file_append_to_async().

copy
bool copy(FileIF destination, GFileCopyFlags flags, Cancellable cancellable, GFileProgressCallback progressCallback, void* progressCallbackData)

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

copyAsync
void copyAsync(FileIF destination, GFileCopyFlags flags, int ioPriority, Cancellable cancellable, GFileProgressCallback progressCallback, void* progressCallbackData, GAsyncReadyCallback callback, void* userData)

Copies the file source to the location specified by destination asynchronously. For details of the behaviour, see g_file_copy().

copyAttributes
bool copyAttributes(FileIF destination, GFileCopyFlags flags, Cancellable cancellable)

Copies the file attributes from source to destination.

copyFinish
bool copyFinish(AsyncResultIF res)

Finishes copying the file started with g_file_copy_async().

create
FileOutputStream create(GFileCreateFlags flags, Cancellable cancellable)

Creates a new file and returns an output stream for writing to it. The file must not already exist.

createAsync
void createAsync(GFileCreateFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist.

createFinish
FileOutputStream createFinish(AsyncResultIF res)

Finishes an asynchronous file create operation started with g_file_create_async().

createReadwrite
FileIOStream createReadwrite(GFileCreateFlags flags, Cancellable cancellable)

Creates a new file and returns a stream for reading and writing to it. The file must not already exist.

createReadwriteAsync
void createReadwriteAsync(GFileCreateFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist.

createReadwriteFinish
FileIOStream createReadwriteFinish(AsyncResultIF res)

Finishes an asynchronous file create operation started with g_file_create_readwrite_async().

deleteAsync
void deleteAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously delete a file. If the file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink().

deleteFinish
bool deleteFinish(AsyncResultIF result)

Finishes deleting a file started with g_file_delete_async().

delete_
bool delete_(Cancellable cancellable)

Deletes a file. If the file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink().

dup
FileIF dup()

Duplicates a GFile handle. This operation does not duplicate the actual file or directory represented by the GFile; see g_file_copy() if attempting to copy a file.

ejectMountable
void ejectMountable(GMountUnmountFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts an asynchronous eject on a mountable. When this operation has completed, callback will be called with user_user data, and the operation can be finalized with g_file_eject_mountable_finish().

ejectMountableFinish
bool ejectMountableFinish(AsyncResultIF result)

Finishes an asynchronous eject operation started by g_file_eject_mountable().

ejectMountableWithOperation
void ejectMountableWithOperation(GMountUnmountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts an asynchronous eject on a mountable. When this operation has completed, callback will be called with user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish().

ejectMountableWithOperationFinish
bool ejectMountableWithOperationFinish(AsyncResultIF result)

Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation().

enumerateChildren
FileEnumerator enumerateChildren(string attributes, GFileQueryInfoFlags flags, Cancellable cancellable)

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.

enumerateChildrenAsync
void enumerateChildrenAsync(string attributes, GFileQueryInfoFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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.

enumerateChildrenFinish
FileEnumerator enumerateChildrenFinish(AsyncResultIF res)

Finishes an async enumerate children operation. See g_file_enumerate_children_async().

equal
bool equal(FileIF file2)

Checks if the two given GFiles refer to the same file.

findEnclosingMount
MountIF findEnclosingMount(Cancellable cancellable)

Gets a GMount for the GFile

findEnclosingMountAsync
void findEnclosingMountAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously gets the mount for the file.

findEnclosingMountFinish
MountIF findEnclosingMountFinish(AsyncResultIF res)

Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async().

getBasename
string getBasename()

Gets the base name (the last component of the path) for a given GFile

getChild
FileIF getChild(string name)

Gets a child of file with basename equal to name.

getChildForDisplayName
FileIF getChildForDisplayName(string displayName)

Gets the child of file for a given display_name (i.e. a UTF-8 version of the name). If this function fails, it returns NULL 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.

getFileStruct
GFile* getFileStruct(bool transferOwnership = false)

Get the main Gtk struct

getParent
FileIF getParent()

Gets the parent directory for the file. If the file represents the root directory of the file system, then NULL will be returned.

getParseName
string getParseName()

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 g_file_parse_name().

getPath
string getPath()

Gets the local pathname for GFile, if one exists. If non-NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks.

getRelativePath
string getRelativePath(FileIF descendant)

Gets the path for descendant relative to parent.

getStruct
void* getStruct()

the main Gtk struct as a void*

getUri
string getUri()

Gets the URI for the file.

getUriScheme
string getUriScheme()

Gets the URI scheme for a GFile RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

hasParent
bool hasParent(FileIF parent)

Checks if file has a parent, and optionally, if it is parent.

hasPrefix
bool hasPrefix(FileIF prefix)

Checks whether file has the prefix specified by prefix.

hasUriScheme
bool hasUriScheme(string uriScheme)

Checks to see if a GFile has a given URI scheme.

hash
uint hash()

Creates a hash value for a GFile

isNative
bool isNative()

Checks to see if a file is native to the platform.

loadBytes
Bytes loadBytes(Cancellable cancellable, out string etagOut)

Loads the contents of file and returns it as GBytes

loadBytesAsync
void loadBytesAsync(Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously loads the contents of file as GBytes

loadBytesFinish
Bytes loadBytesFinish(AsyncResultIF result, out string etagOut)

Completes an asynchronous request to g_file_load_bytes_async().

loadContents
bool loadContents(Cancellable cancellable, out string contents, out string etagOut)

Loads the content of the file into memory. The data is always zero-terminated, but this is not included in the resultant length. The returned content should be freed with g_free() when no longer needed.

loadContentsAsync
void loadContentsAsync(Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts an asynchronous load of the file's contents.

loadContentsFinish
bool loadContentsFinish(AsyncResultIF res, out string contents, out string etagOut)

Finishes an asynchronous load of the file's contents. The contents are placed in contents, and length is set to the size of the contents string. The content should be freed with g_free() when no longer needed. If etag_out is present, it will be set to the new entity tag for the file.

loadPartialContentsAsync
void loadPartialContentsAsync(Cancellable cancellable, GFileReadMoreCallback readMoreCallback, GAsyncReadyCallback callback, void* userData)

Reads the partial contents of a file. A GFileReadMoreCallback should be used to stop reading from the file when appropriate, else this function will behave exactly as g_file_load_contents_async(). This operation can be finished by g_file_load_partial_contents_finish().

loadPartialContentsFinish
bool loadPartialContentsFinish(AsyncResultIF res, out string contents, out string etagOut)

Finishes an asynchronous partial load operation that was started with g_file_load_partial_contents_async(). The data is always zero-terminated, but this is not included in the resultant length. The returned content should be freed with g_free() when no longer needed.

makeDirectory
bool makeDirectory(Cancellable cancellable)

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 g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting error to G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating directories, this function will fail, setting error to G_IO_ERROR_NOT_SUPPORTED.

makeDirectoryAsync
void makeDirectoryAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously creates a directory.

makeDirectoryFinish
bool makeDirectoryFinish(AsyncResultIF result)

Finishes an asynchronous directory creation, started with g_file_make_directory_async().

makeDirectoryWithParents
bool makeDirectoryWithParents(Cancellable cancellable)

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 G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists, this function will fail setting error to G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents().

makeSymbolicLink
bool makeSymbolicLink(string symlinkValue, Cancellable cancellable)

Creates a symbolic link named file which contains the string symlink_value.

measureDiskUsage
bool measureDiskUsage(GFileMeasureFlags flags, Cancellable cancellable, GFileMeasureProgressCallback progressCallback, void* progressData, out ulong diskUsage, out ulong numDirs, out ulong numFiles)

Recursively measures the disk usage of file.

measureDiskUsageAsync
void measureDiskUsageAsync(GFileMeasureFlags flags, int ioPriority, Cancellable cancellable, GFileMeasureProgressCallback progressCallback, void* progressData, GAsyncReadyCallback callback, void* userData)

Recursively measures the disk usage of file.

measureDiskUsageFinish
bool measureDiskUsageFinish(AsyncResultIF result, out ulong diskUsage, out ulong numDirs, out ulong numFiles)

Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information.

monitor
FileMonitor monitor(GFileMonitorFlags flags, Cancellable cancellable)

Obtains a file or directory monitor for the given file, depending on the type of the file.

monitorDirectory
FileMonitor monitorDirectory(GFileMonitorFlags flags, Cancellable cancellable)

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

monitorFile
FileMonitor monitorFile(GFileMonitorFlags flags, Cancellable cancellable)

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

mountEnclosingVolume
void mountEnclosingVolume(GMountMountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts a mount_operation, mounting the volume that contains the file location.

mountEnclosingVolumeFinish
bool mountEnclosingVolumeFinish(AsyncResultIF result)

Finishes a mount operation started by g_file_mount_enclosing_volume().

mountMountable
void mountMountable(GMountMountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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

mountMountableFinish
FileIF mountMountableFinish(AsyncResultIF result)

Finishes a mount operation. See g_file_mount_mountable() for details.

move
bool move(FileIF destination, GFileCopyFlags flags, Cancellable cancellable, GFileProgressCallback progressCallback, void* progressCallbackData)

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.

openReadwrite
FileIOStream openReadwrite(Cancellable cancellable)

Opens an existing file for reading and writing. The result is a GFileIOStream that can be used to read and write the contents of the file.

openReadwriteAsync
void openReadwriteAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously opens file for reading and writing.

openReadwriteFinish
FileIOStream openReadwriteFinish(AsyncResultIF res)

Finishes an asynchronous file read operation started with g_file_open_readwrite_async().

peekPath
string peekPath()

Exactly like g_file_get_path(), but caches the result via g_object_set_qdata_full(). This is useful for example in C applications which mix g_file_* APIs with native ones. It also avoids an extra duplicated string when possible, so will be generally more efficient.

pollMountable
void pollMountable(Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Polls a file of type G_FILE_TYPE_MOUNTABLE

pollMountableFinish
bool pollMountableFinish(AsyncResultIF result)

Finishes a poll operation. See g_file_poll_mountable() for details.

queryDefaultHandler
AppInfoIF queryDefaultHandler(Cancellable cancellable)

Returns the GAppInfo that is registered as the default application to handle the file specified by file.

queryDefaultHandlerAsync
void queryDefaultHandlerAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Async version of g_file_query_default_handler().

queryDefaultHandlerFinish
AppInfoIF queryDefaultHandlerFinish(AsyncResultIF result)

Finishes a g_file_query_default_handler_async() operation.

queryExists
bool queryExists(Cancellable cancellable)

Utility function to check if a particular file exists. This is implemented using g_file_query_info() and as such does blocking I/O.

queryFileType
GFileType queryFileType(GFileQueryInfoFlags flags, Cancellable cancellable)

Utility function to inspect the GFileType of a file. This is implemented using g_file_query_info() and as such does blocking I/O.

queryFilesystemInfo
FileInfo queryFilesystemInfo(string attributes, Cancellable cancellable)

Similar to g_file_query_info(), 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.

queryFilesystemInfoAsync
void queryFilesystemInfoAsync(string attributes, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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).

queryFilesystemInfoFinish
FileInfo queryFilesystemInfoFinish(AsyncResultIF res)

Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async().

queryInfo
FileInfo queryInfo(string attributes, GFileQueryInfoFlags flags, Cancellable cancellable)

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).

queryInfoAsync
void queryInfoAsync(string attributes, GFileQueryInfoFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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).

queryInfoFinish
FileInfo queryInfoFinish(AsyncResultIF res)

Finishes an asynchronous file info query. See g_file_query_info_async().

querySettableAttributes
FileAttributeInfoList querySettableAttributes(Cancellable cancellable)

Obtain the list of settable attributes for the file.

queryWritableNamespaces
FileAttributeInfoList queryWritableNamespaces(Cancellable cancellable)

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).

read
FileInputStream read(Cancellable cancellable)

Opens a file for reading. The result is a GFileInputStream that can be used to read the contents of the file.

readAsync
void readAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously opens file for reading.

readFinish
FileInputStream readFinish(AsyncResultIF res)

Finishes an asynchronous file read operation started with g_file_read_async().

replace
FileOutputStream replace(string etag, bool makeBackup, GFileCreateFlags flags, Cancellable cancellable)

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.

replaceAsync
void replaceAsync(string etag, bool makeBackup, GFileCreateFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first.

replaceContents
bool replaceContents(string contents, string etag, bool makeBackup, GFileCreateFlags flags, out string newEtag, Cancellable cancellable)

Replaces the contents of file with contents of length bytes.

replaceContentsAsync
void replaceContentsAsync(string contents, string etag, bool makeBackup, GFileCreateFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts an asynchronous replacement of file with the given contents of length bytes. etag will replace the document's current entity tag.

replaceContentsBytesAsync
void replaceContentsBytesAsync(Bytes contents, string etag, bool makeBackup, GFileCreateFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Same as g_file_replace_contents_async() but takes a GBytes input instead. This function will keep a ref on contents until the operation is done. Unlike g_file_replace_contents_async() this allows forgetting about the content without waiting for the callback.

replaceContentsFinish
bool replaceContentsFinish(AsyncResultIF res, out string newEtag)

Finishes an asynchronous replace of the given file. See g_file_replace_contents_async(). Sets new_etag to the new entity tag for the document, if present.

replaceFinish
FileOutputStream replaceFinish(AsyncResultIF res)

Finishes an asynchronous file replace operation started with g_file_replace_async().

replaceReadwrite
FileIOStream replaceReadwrite(string etag, bool makeBackup, GFileCreateFlags flags, Cancellable cancellable)

Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created.

replaceReadwriteAsync
void replaceReadwriteAsync(string etag, bool makeBackup, GFileCreateFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first.

replaceReadwriteFinish
FileIOStream replaceReadwriteFinish(AsyncResultIF res)

Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async().

resolveRelativePath
FileIF resolveRelativePath(string relativePath)

Resolves a relative path for file to an absolute path.

setAttribute
bool setAttribute(string attribute, GFileAttributeType type, void* valueP, GFileQueryInfoFlags flags, Cancellable cancellable)

Sets an attribute in the file with attribute name attribute to value.

setAttributeByteString
bool setAttributeByteString(string attribute, string value, GFileQueryInfoFlags flags, Cancellable cancellable)

Sets attribute of type G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to value. If attribute is of a different type, this operation will fail, returning FALSE.

setAttributeInt32
bool setAttributeInt32(string attribute, int value, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setAttributeInt64
bool setAttributeInt64(string attribute, long value, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setAttributeString
bool setAttributeString(string attribute, string value, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setAttributeUint32
bool setAttributeUint32(string attribute, uint value, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setAttributeUint64
bool setAttributeUint64(string attribute, ulong value, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setAttributesAsync
void setAttributesAsync(FileInfo info, GFileQueryInfoFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously sets the attributes of file with info.

setAttributesFinish
bool setAttributesFinish(AsyncResultIF result, out FileInfo info)

Finishes setting an attribute started in g_file_set_attributes_async().

setAttributesFromInfo
bool setAttributesFromInfo(FileInfo info, GFileQueryInfoFlags flags, Cancellable cancellable)

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

setDisplayName
FileIF setDisplayName(string displayName, Cancellable cancellable)

Renames file to the specified display name.

setDisplayNameAsync
void setDisplayNameAsync(string displayName, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously sets the display name for a given GFile

setDisplayNameFinish
FileIF setDisplayNameFinish(AsyncResultIF res)

Finishes setting a display name started with g_file_set_display_name_async().

startMountable
void startMountable(GDriveStartFlags flags, MountOperation startOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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

startMountableFinish
bool startMountableFinish(AsyncResultIF result)

Finishes a start operation. See g_file_start_mountable() for details.

stopMountable
void stopMountable(GMountUnmountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Stops a file of type G_FILE_TYPE_MOUNTABLE

stopMountableFinish
bool stopMountableFinish(AsyncResultIF result)

Finishes an stop operation, see g_file_stop_mountable() for details.

supportsThreadContexts
bool supportsThreadContexts()

Checks if file supports [thread-default contexts][g-main-context-push-thread-default-context]. If this returns FALSE, you cannot perform asynchronous operations on file in a thread that has a thread-default context.

trash
bool trash(Cancellable cancellable)

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 G_IO_ERROR_NOT_SUPPORTED error.

trashAsync
void trashAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously sends file to the Trash location, if possible.

trashFinish
bool trashFinish(AsyncResultIF result)

Finishes an asynchronous file trashing operation, started with g_file_trash_async().

unmountMountable
void unmountMountable(GMountUnmountFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Unmounts a file of type G_FILE_TYPE_MOUNTABLE.

unmountMountableFinish
bool unmountMountableFinish(AsyncResultIF result)

Finishes an unmount operation, see g_file_unmount_mountable() for details.

unmountMountableWithOperation
void unmountMountableWithOperation(GMountUnmountFlags flags, MountOperation mountOperation, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Unmounts a file of type G_FILE_TYPE_MOUNTABLE

unmountMountableWithOperationFinish
bool unmountMountableWithOperationFinish(AsyncResultIF result)

Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.

Static functions

getType
GType getType()
parseName
FileIF parseName(string parseName)

Constructs a GFile with the given parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the parse_name cannot be parsed.