gio.file_mixin

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 [gio.types.FileCreateFlags.Private] 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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Some file systems don't allow all file names, and may return an [gio.types.IOErrorEnum.InvalidFilename] error. If the file is a directory the [gio.types.IOErrorEnum.IsDirectory] error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Asynchronously opens file for appending.

For more details, see [gio.file.File.appendTo] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.appendToFinish] to get the result of the operation.

Finishes an asynchronous file append operation started with [gio.file.File.appendToAsync].

Prepares the file attribute query string for copying to file.

This function prepares an attribute query string to be passed to [gio.file.File.queryInfo] to get a list of attributes normally copied with the file (see [gio.file.File.copyAttributes] for the detailed description). This function is used by the implementation of [gio.file.File.copyAttributes] and is useful when one needs to query and set the attributes in two stages (e.g., for recursive move of a directory).

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

If the flag [gio.types.FileCopyFlags.Overwrite] is specified an already existing destination file is overwritten.

If the flag [gio.types.FileCopyFlags.NofollowSymlinks] is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied.

If the flag [gio.types.FileCopyFlags.AllMetadata] is specified then all the metadata that is possible to copy is copied, not just the default subset (which, for instance, does not include the owner, see #GFileInfo).

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If progress_callback is not null, then the operation can be monitored by setting this to a #GFileProgressCallback function. progress_callback_data 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 [gio.types.IOErrorEnum.NotFound] error is returned, independent on the status of the destination.

If [gio.types.FileCopyFlags.Overwrite] is not specified and the target exists, then the error [gio.types.IOErrorEnum.Exists] is returned.

If trying to overwrite a file over a directory, the [gio.types.IOErrorEnum.IsDirectory] error is returned. If trying to overwrite a directory with a directory the [gio.types.IOErrorEnum.WouldMerge] error is returned.

If the source is a directory and the target does not exist, or [gio.types.FileCopyFlags.Overwrite] is specified and the target is a file, then the [gio.types.IOErrorEnum.WouldRecurse] error is returned.

If you are interested in copying the #GFile object itself (not the on-disk file), see [gio.file.File.dup].

Copies the file source to the location specified by destination asynchronously. For details of the behaviour, see [gio.file.File.copy].

If progress_callback is not null, then that function that will be called just like in [gio.file.File.copy]. The callback will run in the default main context of the thread calling [gio.file.File.copyAsync] — the same context as callback is run in.

When the operation is finished, callback will be called. You can then call [gio.file.File.copyFinish] to get the result of the operation.

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 [gio.types.FileCopyFlags.AllMetadata] 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.

Finishes copying the file started with [gio.file.File.copyAsync].

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 [gio.types.FileCreateFlags.Private] 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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If a file or directory with this name already exists the [gio.types.IOErrorEnum.Exists] error will be returned. Some file systems don't allow all file names, and may return an [gio.types.IOErrorEnum.InvalidFilename] error, and if the name is to long [gio.types.IOErrorEnum.FilenameTooLong] will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

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

For more details, see [gio.file.File.create] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.createFinish] to get the result of the operation.

Finishes an asynchronous file create operation started with [gio.file.File.createAsync].

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

By default files created are generally readable by everyone, but if you pass [gio.types.FileCreateFlags.Private] 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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If a file or directory with this name already exists, the [gio.types.IOErrorEnum.Exists] error will be returned. Some file systems don't allow all file names, and may return an [gio.types.IOErrorEnum.InvalidFilename] error, and if the name is too long, [gio.types.IOErrorEnum.FilenameTooLong] will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing.

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

For more details, see [gio.file.File.createReadwrite] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.createReadwriteFinish] to get the result of the operation.

Finishes an asynchronous file create operation started with [gio.file.File.createReadwriteAsync].

Deletes a file. If the file is a directory, it will only be deleted if it is empty. This has the same semantics as [glib.global.unlink].

If file doesn’t exist, [gio.types.IOErrorEnum.NotFound] will be returned. This allows for deletion to be implemented avoiding

g_autoptr(GError) local_error = NULL;
if (!g_file_delete (my_file, my_cancellable, &local_error) &&
   !g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
 {
   // deletion failed for some reason other than the file not existing:
   // so report the error
   g_warning ("Failed to delete %s: %s",
              g_file_peek_path (my_file), local_error->message);
 }

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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 [glib.global.unlink].

Finishes deleting a file started with [gio.file.File.deleteAsync].

Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see [gio.file.File.copy] if attempting to copy a file.

[gio.file.File.dup] is useful when a second handle is needed to the same underlying file, for use in a separate thread (#GFile is not thread-safe). For use within the same thread, use [gobject.object.ObjectWrap.ref_] to increment the existing object’s reference count.

This call does no blocking I/O.

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 [gio.file.File.ejectMountableFinish].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Finishes an asynchronous eject operation started by [gio.file.File.ejectMountable].

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 [gio.file.File.ejectMountableWithOperationFinish].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Finishes an asynchronous eject operation started by [gio.file.File.ejectMountableWithOperation].

Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.

The attributes 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. attributes should be a comma-separated list of attributes 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::*,owner::user". The standard attributes are available as defines, like [gio.types.FILE_ATTRIBUTE_STANDARD_NAME]. [gio.types.FILE_ATTRIBUTE_STANDARD_NAME] should always be specified if you plan to call [gio.file_enumerator.FileEnumerator.getChild] or [gio.file_enumerator.FileEnumerator.iterate] on the returned enumerator.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If the file does not exist, the [gio.types.IOErrorEnum.NotFound] error will be returned. If the file is not a directory, the [gio.types.IOErrorEnum.NotDirectory] error will be returned. Other errors are possible too.

Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.

For more details, see [gio.file.File.enumerateChildren] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.enumerateChildrenFinish] to get the result of the operation.

Finishes an async enumerate children operation. See [gio.file.File.enumerateChildrenAsync].

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

Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename aliasing.

This call does no blocking I/O.

Gets a #GMount for the #GFile.

#GMount is returned only for user interesting locations, see #GVolumeMonitor. If the #GFileIface for file does not have a #mount, error will be set to [gio.types.IOErrorEnum.NotFound] and null #will be returned.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously gets the mount for the file.

For more details, see [gio.file.File.findEnclosingMount] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.findEnclosingMountFinish] to get the result of the operation.

Finishes an asynchronous find mount request. See [gio.file.File.findEnclosingMountAsync].

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

If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it 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 [gio.types.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME] attribute with [gio.file.File.queryInfo].

This call does no blocking I/O.

Gets a child of file with basename equal to name.

Note that the file with that specific name might not exist, but you can still have a #GFile that points to it. You can use this for instance to create that file.

This call does no blocking I/O.

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.

This call does no blocking I/O.

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

This call does no blocking I/O.

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 [gio.file.File.parseName].

This is generally used to show the #GFile as a nice full-pathname kind of string in a user interface, like in a location entry.

For local files with names that can safely be converted to UTF-8 the pathname is used, otherwise the IRI is used (a form of URI that allows UTF-8 characters unescaped).

This call does no blocking I/O.

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.

This call does no blocking I/O.

Gets the path for descendant relative to parent.

This call does no blocking I/O.

Gets the URI for the file.

This call does no blocking I/O.

Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as:

URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

The scheme can be different from the one used to construct the #GFile, in that it might be replaced with one that is logically equivalent to the #GFile.

This call does no blocking I/O.

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

If parent is null then this function returns true if file has any parent at all. If parent is non-null then true is only returned if file is an immediate child of parent.

Checks whether file has the prefix specified by prefix.

In other words, if the names of initial elements of file's pathname match prefix. Only full pathname elements are matched, so a path like /foo is not considered a prefix of /foobar, only of /foo/bar.

A #GFile is not a prefix of itself. If you want to check for equality, use [gio.file.File.equal].

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.

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

This call does no blocking I/O.

Creates a hash value for a #GFile.

This call does no blocking I/O.

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

A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". 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 [gio.file.File.getPath] will still return a native path.

This call does no blocking I/O.

Loads the contents of file and returns it as #GBytes.

If file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling [gio.file.File.loadContents] and [glib.bytes.Bytes.newTake].

For resources, etag_out will be set to null.

The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with [glib.bytes.Bytes.unref] when no longer in use.

Asynchronously loads the contents of file as #GBytes.

If file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling [gio.file.File.loadContentsAsync] and [glib.bytes.Bytes.newTake].

callback should call [gio.file.File.loadBytesFinish] to get the result of this asynchronous operation.

See [gio.file.File.loadBytes] for more information.

Completes an asynchronous request to [gio.file.File.loadBytesAsync].

For resources, etag_out will be set to null.

The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with [glib.bytes.Bytes.unref] when no longer in use.

See [gio.file.File.loadBytes] for more information.

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 contents should be freed with [glib.global.gfree] when no longer needed.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Starts an asynchronous load of the file's contents.

For more details, see [gio.file.File.loadContents] which is the synchronous version of this call.

When the load operation has completed, callback will be called with user data. To finish the operation, call [gio.file.File.loadContentsFinish] with the #GAsyncResult returned by the callback.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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 contents should be freed with [glib.global.gfree] when no longer needed. If etag_out is present, it will be set to the new entity tag for the file.

Finishes an asynchronous partial load operation that was started with [gio.file.File.loadPartialContentsAsync]. The data is always zero-terminated, but this is not included in the resultant length. The returned contents should be freed with [glib.global.gfree] when no longer needed.

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 [gio.file.File.makeDirectoryWithParents]. This function will fail if the parent directory does not exist, setting error to [gio.types.IOErrorEnum.NotFound]. If the file system doesn't support creating directories, this function will fail, setting error to [gio.types.IOErrorEnum.NotSupported].

For a local #GFile the newly created directory will have the default (current) ownership and permissions of the current process.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously creates a directory.

Finishes an asynchronous directory creation, started with [gio.file.File.makeDirectoryAsync].

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 [gio.types.IOErrorEnum.NotSupported]. If the directory itself already exists, this function will fail setting error to [gio.types.IOErrorEnum.Exists], unlike the similar [glib.global.mkdirWithParents].

For a local #GFile the newly created directories will have the default (current) ownership and permissions of the current process.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously creates a symbolic link named file which contains the string symlink_value.

Finishes an asynchronous symbolic link creation, started with [gio.file.File.makeSymbolicLinkAsync].

Recursively measures the disk usage of file.

This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered (including things like symbolic links).

By default, errors are only reported against the toplevel file itself. Errors found while recursing are silently ignored, unless [gio.types.FileMeasureFlags.ReportAnyError] is given in flags.

The returned size, disk_usage, is in bytes and should be formatted with [glib.global.formatSize] in order to get something reasonable for showing in a user interface.

progress_callback and progress_data can be given to request periodic progress updates while scanning. See the documentation for #GFileMeasureProgressCallback for information about when and how the callback will be invoked.

Collects the results from an earlier call to [gio.file.File.measureDiskUsageAsync]. See [gio.file.File.measureDiskUsage] for more information.

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

It does not make sense for flags to contain [gio.types.FileMonitorFlags.WatchHardLinks], since hard links can not be made to directories. It is not possible to monitor all the files in a directory for changes made via hard links; if you want to do this then you must register individual watches with [gio.file.File.monitor].

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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If flags contains [gio.types.FileMonitorFlags.WatchHardLinks] then the monitor will also attempt to report changes made to the file via another filename (ie, a hard link). Without this flag, you can only rely on changes made through the filename contained in file to be reported. Using this flag may result in an increase in resource usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type.

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

When this operation has completed, callback will be called with user_user data, and the operation can be finalized with [gio.file.File.mountEnclosingVolumeFinish].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Finishes a mount operation started by [gio.file.File.mountEnclosingVolume].

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.mountMountableFinish] to get the result of the operation.

Finishes a mount operation. See [gio.file.File.mountMountable] for details.

Finish an asynchronous mount operation that was started with [gio.file.File.mountMountable].

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 [gio.types.FileCopyFlags.Overwrite] is specified an already existing destination file is overwritten.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If progress_callback is not null, then the operation can be monitored by setting this to a #GFileProgressCallback function. progress_callback_data 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 [gio.types.IOErrorEnum.NotFound] error is returned, independent on the status of the destination.

If [gio.types.FileCopyFlags.Overwrite] is not specified and the target exists, then the error [gio.types.IOErrorEnum.Exists] is returned.

If trying to overwrite a file over a directory, the [gio.types.IOErrorEnum.IsDirectory] error is returned. If trying to overwrite a directory with a directory the [gio.types.IOErrorEnum.WouldMerge] error is returned.

If the source is a directory and the target does not exist, or [gio.types.FileCopyFlags.Overwrite] is specified and the target is a file, then the [gio.types.IOErrorEnum.WouldRecurse] error may be returned (if the native move operation isn't available).

Asynchronously moves a file source to the location of destination. For details of the behaviour, see [gio.file.File.move].

If progress_callback is not null, then that function that will be called just like in [gio.file.File.move]. The callback will run in the default main context of the thread calling [gio.file.File.moveAsync] — the same context as callback is run in.

When the operation is finished, callback will be called. You can then call [gio.file.File.moveFinish] to get the result of the operation.

Finishes an asynchronous file movement, started with [gio.file.File.moveAsync].

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.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If the file does not exist, the [gio.types.IOErrorEnum.NotFound] error will be returned. If the file is a directory, the [gio.types.IOErrorEnum.IsDirectory] error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing.

Asynchronously opens file for reading and writing.

For more details, see [gio.file.File.openReadwrite] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.openReadwriteFinish] to get the result of the operation.

Finishes an asynchronous file read operation started with [gio.file.File.openReadwriteAsync].

Exactly like [gio.file.File.getPath], but caches the result via [gobject.object.ObjectWrap.setQdataFull]. 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.

This call does no blocking I/O.

Polls a file of type [gio.types.FileType.Mountable].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.mountMountableFinish] to get the result of the operation.

Finishes a poll operation. See [gio.file.File.pollMountable] for details.

Finish an asynchronous poll operation that was polled with [gio.file.File.pollMountable].

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Async version of [gio.file.File.queryDefaultHandler].

Finishes a [gio.file.File.queryDefaultHandlerAsync] operation.

Utility function to check if a particular file exists. This is implemented using [gio.file.File.queryInfo] 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 [gio.file.File.create] which will either atomically create the file or fail with a [gio.types.IOErrorEnum.Exists] 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 an 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.

Utility function to inspect the #GFileType of a file. This is implemented using [gio.file.File.queryInfo] 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.

Similar to [gio.file.File.queryInfo], 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 attributes value is a string that specifies the 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. attributes should be a comma-separated list of attributes or attribute wildcards. The wildcard "*" means all attributes, and a wildcard like "filesystem::*" means all attributes in the filesystem namespace. The standard namespace for filesystem attributes is "filesystem". Common attributes of interest are [gio.types.FILE_ATTRIBUTE_FILESYSTEM_SIZE] (the total size of the filesystem in bytes), [gio.types.FILE_ATTRIBUTE_FILESYSTEM_FREE] (number of bytes available), and [gio.types.FILE_ATTRIBUTE_FILESYSTEM_TYPE] (type of the filesystem).

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If the file does not exist, the [gio.types.IOErrorEnum.NotFound] error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Asynchronously gets the requested information about the filesystem that the specified file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file).

For more details, see [gio.file.File.queryFilesystemInfo] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.queryInfoFinish] to get the result of the operation.

Finishes an asynchronous filesystem info query. See [gio.file.File.queryFilesystemInfoAsync].

Gets the requested information about specified file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file).

The attributes 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. attributes should be a comma-separated list of attributes 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::*,owner::user". The standard attributes are available as defines, like [gio.types.FILE_ATTRIBUTE_STANDARD_NAME].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] 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 [gio.types.FileQueryInfoFlags.NofollowSymlinks] 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 [gio.types.IOErrorEnum.NotFound] error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Asynchronously gets the requested information about specified file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file).

For more details, see [gio.file.File.queryInfo] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.queryInfoFinish] to get the result of the operation.

Finishes an asynchronous file info query. See [gio.file.File.queryInfoAsync].

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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If the file does not exist, the [gio.types.IOErrorEnum.NotFound] error will be returned. If the file is a directory, the [gio.types.IOErrorEnum.IsDirectory] error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Asynchronously opens file for reading.

For more details, see [gio.file.File.read] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.readFinish] to get the result of the operation.

Finishes an asynchronous file read operation started with [gio.file.File.readAsync].

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 [gio.types.FileCreateFlags.Private] 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 null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If you pass in a non-null etag value and file already exists, then this value is compared to the current entity tag of the file, and if they differ an [gio.types.IOErrorEnum.WrongEtag] error is returned. This generally means that the file has been changed since you last read it. You can get the new etag from [gio.file_output_stream.FileOutputStream.getEtag] after you've finished writing and closed the #GFileOutputStream. When you load a new file you can use [gio.file_input_stream.FileInputStream.queryInfo] to get the etag of the file.

If make_backup is true, this function will attempt to make a backup of the current file before overwriting it. If this fails a [gio.types.IOErrorEnum.CantCreateBackup] error will be returned. If you want to replace anyway, try again with make_backup set to false.

If the file is a directory the [gio.types.IOErrorEnum.IsDirectory] error will be returned, and if the file is some other form of non-regular file then a [gio.types.IOErrorEnum.NotRegularFile] error will be returned. Some file systems don't allow all file names, and may return an [gio.types.IOErrorEnum.InvalidFilename] error, and if the name is to long [gio.types.IOErrorEnum.FilenameTooLong] will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

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

For more details, see [gio.file.File.replace] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.replaceFinish] to get the result of the operation.

Replaces the contents of file with contents of length bytes.

If etag is specified (not null), any existing file must have that etag, or the error [gio.types.IOErrorEnum.WrongEtag] will be returned.

If make_backup is true, this function will attempt to make a backup of file. Internally, it uses [gio.file.File.replace], so will try to replace the file contents in the safest way possible. For example, atomic renames are used when replacing local files’ contents.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

The returned new_etag can be used to verify that the file hasn't changed the next time it is saved over.

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

When this operation has completed, callback will be called with user_user data, and the operation can be finalized with [gio.file.File.replaceContentsFinish].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

If make_backup is true, this function will attempt to make a backup of file.

Note that no copy of contents will be made, so it must stay valid until callback is called. See [gio.file.File.replaceContentsBytesAsync] for a #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

Same as [gio.file.File.replaceContentsAsync] but takes a #GBytes input instead. This function will keep a ref on contents until the operation is done. Unlike [gio.file.File.replaceContentsAsync] this allows forgetting about the content without waiting for the callback.

When this operation has completed, callback will be called with user_user data, and the operation can be finalized with [gio.file.File.replaceContentsFinish].

Finishes an asynchronous replace of the given file. See [gio.file.File.replaceContentsAsync]. Sets new_etag to the new entity tag for the document, if present.

Finishes an asynchronous file replace operation started with [gio.file.File.replaceAsync].

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.

For details about the behaviour, see [gio.file.File.replace] which does the same thing but returns an output stream only.

Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing.

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

For more details, see [gio.file.File.replaceReadwrite] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.replaceReadwriteFinish] to get the result of the operation.

Finishes an asynchronous file replace operation started with [gio.file.File.replaceReadwriteAsync].

Resolves a relative path for file to an absolute path.

This call does no blocking I/O.

If the relative_path is an absolute path name, the resolution is done absolutely (without taking file path as base).

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

Some attributes can be unset by setting type to [gio.types.FileAttributeType.Invalid] and value_p to null.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.ByteString] to value. If attribute is of a different type, this operation will fail, returning false.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.Int32] to value. If attribute is of a different type, this operation will fail.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.Int64] to value. If attribute is of a different type, this operation will fail.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.String] to value. If attribute is of a different type, this operation will fail.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.Uint32] to value. If attribute is of a different type, this operation will fail.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Sets attribute of type [gio.types.FileAttributeType.Uint64] to value. If attribute is of a different type, this operation will fail.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously sets the attributes of file with info.

For more details, see [gio.file.File.setAttributesFromInfo], which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.setAttributesFinish] to get the result of the operation.

Finishes setting an attribute started in [gio.file.File.setAttributesAsync].

Tries to set all attributes in the #GFileInfo 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 [gio.types.FileAttributeStatus.ErrorSetting], which means you can also detect further errors.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Renames file to the specified display name.

The display name is converted from UTF-8 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 ([gio.types.FILE_ATTRIBUTE_STANDARD_EDIT_NAME]) should be used as the initial value in the rename widget, and then the result after editing should be passed to [gio.file.File.setDisplayName].

On success the resulting converted filename is returned.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously sets the display name for a given #GFile.

For more details, see [gio.file.File.setDisplayName] which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call [gio.file.File.setDisplayNameFinish] to get the result of the operation.

Finishes setting a display name started with [gio.file.File.setDisplayNameAsync].

Starts a file of type [gio.types.FileType.Mountable]. Using start_operation, you can request callbacks when, for instance, passwords are needed during authentication.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.mountMountableFinish] to get the result of the operation.

Finishes a start operation. See [gio.file.File.startMountable] for details.

Finish an asynchronous start operation that was started with [gio.file.File.startMountable].

Stops a file of type [gio.types.FileType.Mountable].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.stopMountableFinish] to get the result of the operation.

Finishes a stop operation, see [gio.file.File.stopMountable] for details.

Finish an asynchronous stop operation that was started with [gio.file.File.stopMountable].

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.

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 [gio.types.IOErrorEnum.NotSupported] error. Since GLib 2.66, the x-gvfs-notrash unix mount option can be used to disable [gio.file.File.trash] support for certain mounts, the [gio.types.IOErrorEnum.NotSupported] error will be returned in that case.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

Asynchronously sends file to the Trash location, if possible.

Finishes an asynchronous file trashing operation, started with [gio.file.File.trashAsync].

Unmounts a file of type G_FILE_TYPE_MOUNTABLE.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.unmountMountableFinish] to get the result of the operation.

Finishes an unmount operation, see [gio.file.File.unmountMountable] for details.

Finish an asynchronous unmount operation that was started with [gio.file.File.unmountMountable].

Unmounts a file of type [gio.types.FileType.Mountable].

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [gio.types.IOErrorEnum.Cancelled] will be returned.

When the operation is finished, callback will be called. You can then call [gio.file.File.unmountMountableFinish] to get the result of the operation.

Finishes an unmount operation, see [gio.file.File.unmountMountableWithOperation] for details.

Finish an asynchronous unmount operation that was started with [gio.file.File.unmountMountableWithOperation].