[82:7] extends: object
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 [class@Gio.InputStream] and
[class@Gio.OutputStream]). To construct a GFile, you can use: -
[func@Gio.File.new_for_path] if you have a path. -
[func@Gio.File.new_for_uri] if you have a URI. -
[func@Gio.File.new_for_commandline_arg] or
[func@Gio.File.new_for_commandline_arg_and_cwd] for a command line argument.
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 [method@Gio.File.get_parent]
to get an identifier for the parent directory, [method@Gio.File.get_child] to
get a child within a directory, and [method@Gio.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
[method@Gio.File.get_parent] on two different files. All GFiles have a
basename (get with [method@Gio.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
[method@Gio.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 [callback@Gio.AsyncReadyCallback] which is
then used to finalize the operation, producing a [iface@Gio.AsyncResult]
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 for more. Some GFile
operations almost always take a noticeable amount of time, and so do not have
synchronous analogs. Notable cases include: -
[method@Gio.File.mount_mountable] to mount a mountable file. -
[method@Gio.File.unmount_mountable_with_operation] to unmount a mountable
file. - [method@Gio.File.eject_mountable_with_operation] to eject a mountable
file. ## Entity Tags 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 description of
HTTP ETags in
RFC9110. GFile
Entity Tags are a very similar concept.File (Handle = null)
Creates a new
Fileby wrapping a native handle or another wrapper.
Handle is the native handle or another wrapper whose handle to adopt.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.append_to (string flags, object cancellable)
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 %G_FILE_CREATE_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 %G_IO_ERROR_CANCELLED will be returned. Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
flags is a set of #GFileCreateFlags.cancellable is optional #GCancellable object, %NULL to ignore.append_to_finish (object res)
Finishes an asynchronous file append operation started with g_file_append_to_async().
res is #GAsyncResult.build_attribute_list_for_copy (string flags, object cancellable)
Prepares the file attribute query string for copying to @file. This function prepares an attribute query string to be passed to g_file_query_info() to get a list of attributes normally copied with the file (see g_file_copy_attributes() for the detailed description). This function is used by the implementation of g_file_copy_attributes() and is useful when one needs to query and set the attributes in two stages (e.g., for recursive move of a directory).
flags is a set of #GFileCopyFlags.cancellable is optional #GCancellable object, %NULL to ignore.copy_async_with_closures (object destination, string flags, int io_priority, object cancellable, object progress_callback_closure, object ready_callback_closure)
Version of [method@Gio.File.copy_async] using closures instead of callbacks for easier binding in other languages.
destination is destination [type@Gio.File].flags is set of [flags@Gio.FileCopyFlags].io_priority is the I/O priority of the request.cancellable is optional [class@Gio.Cancellable] object, NULL to ignore.progress_callback_closure is [type@GObject.Closure] to invoke with progress information, or NULL if progress information is not needed.ready_callback_closure is [type@GObject.Closure] to invoke when the request is satisfied.None.copy_attributes (object destination, string flags, object cancellable)
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 %G_FILE_COPY_ALL_METADATA 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.
destination is a #GFile to copy attributes to.flags is a set of #GFileCopyFlags.cancellable is optional #GCancellable object, %NULL to ignore.copy_finish (object res)
Finishes copying the file started with g_file_copy_async().
res is a #GAsyncResult.create (string flags, object cancellable)
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 %G_FILE_CREATE_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 %G_IO_ERROR_CANCELLED will be returned. If a file or directory with this name already exists the %G_IO_ERROR_EXISTS error will be returned. Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
flags is a set of #GFileCreateFlags.cancellable is optional #GCancellable object, %NULL to ignore.create_finish (object res)
Finishes an asynchronous file create operation started with g_file_create_async().
res is a #GAsyncResult.create_readwrite (string flags, object cancellable)
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 %G_FILE_CREATE_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 %G_IO_ERROR_CANCELLED will be returned. If a file or directory with this name already exists, the %G_IO_ERROR_EXISTS error will be returned. Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG 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.
flags is a set of #GFileCreateFlags.cancellable is optional #GCancellable object, %NULL to ignore.create_readwrite_finish (object res)
Finishes an asynchronous file create operation started with g_file_create_readwrite_async().
res is a #GAsyncResult.delete (object 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(). If @file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows for deletion to be implemented avoiding time-of-check to time-of-use races: |[ 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 %G_IO_ERROR_CANCELLED will be returned.
cancellable is optional #GCancellable object, %NULL to ignore.delete_finish (object result)
Finishes deleting a file started with g_file_delete_async().
result is a #GAsyncResult.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. g_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 g_object_ref() to increment the existing object’s reference count. This call does no blocking I/O.
eject_mountable_finish (object result)
Finishes an asynchronous eject operation started by g_file_eject_mountable().
result is a #GAsyncResult.eject_mountable_with_operation_finish (object result)
Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation().
result is a #GAsyncResult.enumerate_children (string attributes, string flags, object cancellable)
Gets the requested information about the files in a directory. The result is a [class@FileEnumerator] object that will give out [class@FileInfo] 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 [const@FILE_ATTRIBUTE_STANDARD_NAME]. [const@FILE_ATTRIBUTE_STANDARD_NAME] should always be specified if you plan to call [method@FileEnumerator.get_child] or [method@FileEnumerator.iterate] on the returned enumerator. If
is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [error@Gio.IOErrorEnum.CANCELLED] will be returned. If the file does not exist, the [error@Gio.IOErrorEnum.NOT_FOUND] error will be returned. If the file is not a directory, the [error@Gio.IOErrorEnum.NOT_DIRECTORY] error will be returned. Other errors are possible too.attributes is an attribute query string.flags is a set of #GFileQueryInfoFlags.cancellable is optional #GCancellable object, %NULL to ignore.enumerate_children_finish (object res)
Finishes an async enumerate children operation. See g_file_enumerate_children_async().
res is a #GAsyncResult.equal (object file2)
Checks if the two given #GFiles refer to the same file. This function can be used with [method@Gio.File.hash] to insert [iface@Gio.File]s efficiently in a hash table. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename aliasing. For local files, this function essentially compares the file paths, so two [iface@Gio.File]s which point to different hard or soft links will not be considered equal, despite pointing to the same content. For determining whether two files are hardlinked, see [const@Gio.FILE_ATTRIBUTE_ID_FILE]. This call does no blocking I/O.
file2 is the second #GFile.find_enclosing_mount (object cancellable)
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 %G_IO_ERROR_NOT_FOUND 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 %G_IO_ERROR_CANCELLED will be returned.
cancellable is optional #GCancellable object, %NULL to ignore.find_enclosing_mount_finish (object res)
Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async().
res is a #GAsyncResult.get_basename ()
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 %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). This call does no blocking I/O.
get_child (string name)
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.
name is string containing the child's basename.get_child_for_display_name (string display_name)
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.
display_name is string to a possible child.get_parent ()
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.
get_parse_name ()
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(). 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.
get_path ()
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.
get_relative_path (object descendant)
Gets the path for @descendant relative to @parent. This call does no blocking I/O.
descendant is input #GFile.get_uri ()
Gets the URI for the @file. This call does no blocking I/O.
get_uri_scheme ()
Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include "file", "http", "ftp", etc. 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.
has_parent (object parent)
Checks if @file has a parent, and optionally, if it is @parent. If
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.parent is the parent to check for, or %NULL.has_prefix (object prefix)
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 g_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.
prefix is input #GFile.has_uri_scheme (string uri_scheme)
Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O.
uri_scheme is a string containing a URI scheme.hash ()
Creates a hash value for a #GFile. This call does no blocking I/O.
is_native ()
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 g_file_get_path() will still return a native path. This call does no blocking I/O.
make_directory (object 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
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. If the directory already exists, [error@Gio.IOErrorEnum.EXISTS] will be returned. 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 %G_IO_ERROR_CANCELLED will be returned.cancellable is optional #GCancellable object, %NULL to ignore.make_directory_finish (object result)
Finishes an asynchronous directory creation, started with g_file_make_directory_async().
result is a #GAsyncResult.make_directory_with_parents (object 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
to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents(). For a local #GFile the newly created directories will have the default (current) ownership and permissions of the current process. Ifis not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.cancellable is optional #GCancellable object, %NULL to ignore.make_symbolic_link (string symlink_value, object cancellable)
Creates a symbolic link named @file which contains the string
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 %G_IO_ERROR_CANCELLED will be returned.symlink_value is a string with the path for the target of the new symlink.cancellable is optional #GCancellable object, %NULL to ignore.make_symbolic_link_finish (object result)
Finishes an asynchronous symbolic link creation, started with g_file_make_symbolic_link_async().
result is a #GAsyncResult.monitor (string flags, object cancellable)
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 %G_IO_ERROR_CANCELLED will be returned.
flags is a set of #GFileMonitorFlags.cancellable is optional #GCancellable object, %NULL to ignore.monitor_directory (string flags, object cancellable)
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 %G_IO_ERROR_CANCELLED will be returned. It does not make sense for @flags to contain %G_FILE_MONITOR_WATCH_HARD_LINKS, 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 g_file_monitor().
flags is a set of #GFileMonitorFlags.cancellable is optional #GCancellable object, %NULL to ignore.monitor_file (string flags, object cancellable)
Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If
is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Ifcontains %G_FILE_MONITOR_WATCH_HARD_LINKS 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.flags is a set of #GFileMonitorFlags.cancellable is optional #GCancellable object, %NULL to ignore.mount_enclosing_volume_finish (object result)
Finishes a mount operation started by g_file_mount_enclosing_volume().
result is a #GAsyncResult.mount_mountable_finish (object result)
Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable().
result is a #GAsyncResult.move_async_with_closures (object destination, string flags, int io_priority, object cancellable, object progress_callback_closure, object ready_callback_closure)
Version of [method@Gio.File.move_async] using closures instead of callbacks for easier binding in other languages.
destination is destination [type@Gio.File].flags is set of [flags@Gio.FileCopyFlags].io_priority is the I/O priority of the request.cancellable is optional [class@Gio.Cancellable] object, NULL to ignore.progress_callback_closure is [type@GObject.Closure] to invoke with progress information, or NULL if progress information is not needed.ready_callback_closure is [type@GObject.Closure] to invoke when the request is satisfied.None.move_finish (object result)
Finishes an asynchronous file movement, started with g_file_move_async().
result is a #GAsyncResult.open_readwrite (object 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. 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 %G_IO_ERROR_CANCELLED will be returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY 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.
cancellable is a #GCancellable.open_readwrite_finish (object res)
Finishes an asynchronous file read operation started with g_file_open_readwrite_async().
res is a #GAsyncResult.peek_path ()
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. This call does no blocking I/O.
poll_mountable_finish (object result)
Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable().
result is a #GAsyncResult.query_default_handler (object cancellable)
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 %G_IO_ERROR_CANCELLED will be returned.
cancellable is optional #GCancellable object, %NULL to ignore.query_default_handler_finish (object result)
Finishes a g_file_query_default_handler_async() operation.
result is a #GAsyncResult.query_exists (object cancellable)
Utility function to check if a particular file exists. The fallback implementation of this API is using [method@Gio.File.query_info] and therefore may do blocking I/O. To asynchronously query the existence of a file, use [method@Gio.File.query_info_async]. 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 g_file_create() which will either atomically create the file or fail with a %G_IO_ERROR_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.
cancellable is optional #GCancellable object, %NULL to ignore.query_file_type (string flags, object 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. The primary use case of this method is to check if a file is a regular file, directory, or symlink.
flags is a set of #GFileQueryInfoFlags passed to g_file_query_info().cancellable is optional #GCancellable object, %NULL to ignore.query_filesystem_info (string attributes, object 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. 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 %G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem in bytes), %G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available), and %G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). If
is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.attributes is an attribute query string.cancellable is optional #GCancellable object, %NULL to ignore.query_filesystem_info_finish (object res)
Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async().
res is a #GAsyncResult.query_info (string attributes, string flags, object cancellable)
Gets the requested information about specified @file. The result is a [class@Gio.FileInfo] 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. In particular this means that if a file is inaccessible (due to being in a folder with restrictive permissions), for example, you can expect the returned [class@Gio.FileInfo] to have very few attributes set. You should check whether an attribute is set using [method@Gio.FileInfo.has_attribute] before trying to retrieve its value. It is guaranteed that if any of the following attributes are listed in
they will always be set in the returned [class@Gio.FileInfo], even if the user doesn’t have permissions to access the file: - [const@Gio.FILE_ATTRIBUTE_STANDARD_NAME] - [const@Gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME] @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 might be "standard::*,owner::user". The standard attributes are available as defines, like [const@Gio.FILE_ATTRIBUTE_STANDARD_NAME]. Ifis not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error [error@Gio.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 [flags@Gio.FileQueryInfoFlags.NOFOLLOW_SYMLINKS] inthe 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 [error@Gio.IOErrorEnum.NOT_FOUND] error will be returned. Other errors are possible too, and depend on what kind of file system the file is on.attributes is an attribute query string.flags is flags to affect the query operation.cancellable is optional cancellable object.query_info_finish (object res)
Finishes an asynchronous file info query. See g_file_query_info_async().
res is a #GAsyncResult.query_settable_attributes (object cancellable)
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 %G_IO_ERROR_CANCELLED will be returned.
cancellable is optional #GCancellable object, %NULL to ignore.query_writable_namespaces (object 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). 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 %G_IO_ERROR_CANCELLED will be returned.
cancellable is optional #GCancellable object, %NULL to ignore.read (object cancellable)
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 %G_IO_ERROR_CANCELLED will be returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
cancellable is a #GCancellable.read_finish (object res)
Finishes an asynchronous file read operation started with g_file_read_async().
res is a #GAsyncResult.replace (string etag, bool make_backup, string flags, object 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. 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 %G_FILE_CREATE_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 %G_IO_ERROR_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 %G_IO_ERROR_WRONG_ETAG error is returned. This generally means that the file has been changed since you last read it. You can get the new etag from g_file_output_stream_get_etag() after you've finished writing and closed the #GFileOutputStream. When you load a new file you can use g_file_input_stream_query_info() to get the etag of the file. If
is %TRUE, this function will attempt to make a backup of the current file before overwriting it. If this fails a %G_IO_ERROR_CANT_CREATE_BACKUP 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 %G_IO_ERROR_IS_DIRECTORY error will be returned, and if the file is some other form of non-regular file then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.etag is an optional entity tag for the current #GFile, or #NULL to ignore.make_backup is %TRUE if a backup should be created.flags is a set of #GFileCreateFlags.cancellable is optional #GCancellable object, %NULL to ignore.replace_finish (object res)
Finishes an asynchronous file replace operation started with g_file_replace_async().
res is a #GAsyncResult.replace_readwrite (string etag, bool make_backup, string flags, object 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. For details about the behaviour, see g_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.
etag is an optional entity tag for the current #GFile, or #NULL to ignore.make_backup is %TRUE if a backup should be created.flags is a set of #GFileCreateFlags.cancellable is optional #GCancellable object, %NULL to ignore.replace_readwrite_finish (object res)
Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async().
res is a #GAsyncResult.resolve_relative_path (string relative_path)
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).
relative_path is a given relative path string.set_attribute (string attribute, string type, value_p, string flags, object cancellable)
Sets an attribute in the file with attribute name @attribute to @value_p. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_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 %G_IO_ERROR_CANCELLED will be returned.
attribute is a string containing the attribute's name.type is The type of the attribute.value_p is a pointer to the value (or the pointer itself if the type is a pointer type).flags is a set of #GFileQueryInfoFlags.cancellable is optional #GCancellable object, %NULL to ignore.set_attribute_byte_string (string attribute, string value, string flags, object cancellable)
Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. If
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 %G_IO_ERROR_CANCELLED will be returned.attribute is a string containing the attribute's name.value is a string containing the attribute's new value.flags is a #GFileQueryInfoFlags.cancellable is optional #GCancellable object, %NULL to ignore.set_attribute_string (string attribute, string value, string flags, object cancellable)
Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. If
is of a different type, this operation will fail. Ifis not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.attribute is a string containing the attribute's name.value is a string containing the attribute's value.flags is #GFileQueryInfoFlags.cancellable is optional #GCancellable object, %NULL to ignore.set_attributes_from_info (object info, string flags, object cancellable)
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 %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, 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 %G_IO_ERROR_CANCELLED will be returned.
info is a #GFileInfo.flags is #GFileQueryInfoFlags.cancellable is optional #GCancellable object, %NULL to ignore.set_display_name (string display_name, object cancellable)
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 (%G_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 g_file_set_display_name(). 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 %G_IO_ERROR_CANCELLED will be returned.
display_name is a string.cancellable is optional #GCancellable object, %NULL to ignore.set_display_name_finish (object res)
Finishes setting a display name started with g_file_set_display_name_async().
res is a #GAsyncResult.start_mountable_finish (object result)
Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable().
result is a #GAsyncResult.stop_mountable_finish (object result)
Finishes a stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable().
result is a #GAsyncResult.supports_thread_contexts ()
Checks if @file supports thread-default main contexts (see [method@GLib.MainContext.push_thread_default]) If this returns %FALSE, you cannot perform asynchronous operations on @file in a thread that has a thread-default context.
trash (object cancellable)
Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Trashing is disabled for system mounts by default (see g_unix_mount_entry_is_system_internal()), so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the
x-gvfs-notrashunix mount option can be used to disable g_file_trash() support for particular mounts, the %G_IO_ERROR_NOT_SUPPORTED error will be returned in that case. Since 2.82, thex-gvfs-trashunix mount option can be used to enable g_file_trash() support for particular system mounts. If
is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.cancellable is optional #GCancellable object, %NULL to ignore.trash_finish (object result)
Finishes an asynchronous file trashing operation, started with g_file_trash_async().
result is a #GAsyncResult.unmount_mountable_finish (object result)
Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable().
result is a #GAsyncResult.unmount_mountable_with_operation_finish (object result)
Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation().
result is a #GAsyncResult.
