Interface File

All Superinterfaces:
Proxy
All Known Implementing Classes:
File.File$Impl
@Generated("org.javagi.JavaGI") public interface File extends Proxy

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 InputStream and OutputStream).

To construct a GFile, you can use:

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

GFiles make up hierarchies of directories and files that correspond to the files on a filesystem. You can move through the file system with GFile using getParent() to get an identifier for the parent directory, getChild(String) to get a child within a directory, and resolveRelativePath(String) 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 getParent() on two different files.

All GFiles have a basename (get with getBasename()). 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 queryInfo(String, Set, Cancellable). 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 Gio.AsyncReadyCallback which is then used to finalize the operation, producing a 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:

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.

  • Method Details

    • getType

      static @Nullable Type getType()
      Get the GType of the File class.
      Returns:
      the GType

    • newBuildFilename

      static File newBuildFilename(String firstElement, Object... varargs)

      Constructs a GFile from a series of elements using the correct separator for filenames.

      Using this function is equivalent to calling g_build_filename(), followed by g_file_new_for_path() on the result.

      Parameters:
      firstElement - the first element in the path
      varargs - remaining elements in path, terminated by null
      Returns:
      a new GFile
      Since:
      2.56

    • newBuildFilenamev

      static File newBuildFilenamev(@Nullable String @Nullable [] args)

      Constructs a GFile from a vector of elements using the correct separator for filenames.

      Using this function is equivalent to calling g_build_filenamev(), followed by g_file_new_for_path() on the result.

      Parameters:
      args - null-terminated array of strings containing the path elements.
      Returns:
      a new GFile
      Since:
      2.78

    • newForCommandlineArg

      static File newForCommandlineArg(String arg)

      Creates a GFile with the given argument from the command line. The value of arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not support any I/O operation if arg points to a malformed path.

      Note that on Windows, this function expects its argument to be in UTF-8 -- not the system code page. This means that you should not use this function with string from argv as it is passed to main(). g_win32_get_command_line() will return a UTF-8 version of the commandline. GApplication also uses UTF-8 but g_application_command_line_create_file_for_arg() may be more useful for you there. It is also always possible to use this function with GOptionContext arguments of type OptionArg.FILENAME.

      Parameters:
      arg - a command line string
      Returns:
      a new GFile. Free the returned object with g_object_unref().

    • newForCommandlineArgAndCwd

      static File newForCommandlineArgAndCwd(String arg, String cwd)

      Creates a GFile with the given argument from the command line.

      This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an argument instead of using the current working directory of the process.

      This is useful if the commandline argument was given in a context other than the invocation of the current process.

      See also g_application_command_line_create_file_for_arg().

      Parameters:
      arg - a command line string
      cwd - the current working directory of the commandline
      Returns:
      a new GFile
      Since:
      2.36

    • newForPath

      static File newForPath(String path)
      Constructs a GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if path is malformed.
      Parameters:
      path - a string containing a relative or absolute path. The string must be encoded in the glib filename encoding.
      Returns:
      a new GFile for the given path. Free the returned object with g_object_unref().

    • newForUri

      static File newForUri(String uri)
      Constructs a GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if uri is malformed or if the uri type is not supported.
      Parameters:
      uri - a UTF-8 string containing a URI
      Returns:
      a new GFile for the given uri. Free the returned object with g_object_unref().

    • newTmp

      static File newTmp(@Nullable String tmpl, Out<FileIOStream> iostream) throws GErrorException

      Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a GFile and GFileIOStream pointing to it.

      tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is null, a default template is used.

      Unlike the other GFile constructors, this will return null if a temporary file could not be created.

      Parameters:
      tmpl - Template for the file name, as in g_file_open_tmp(), or null for a default template
      iostream - on return, a GFileIOStream for the created file
      Returns:
      a new GFile. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.32

    • newTmpAsync

      static void newTmpAsync(@Nullable String tmpl, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_file_new_tmp().

      tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is null, a default template is used.

      Parameters:
      tmpl - Template for the file name, as in g_file_open_tmp(), or null for a default template
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is done
      Since:
      2.74

    • newTmpDirAsync

      static void newTmpDirAsync(@Nullable String tmpl, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously creates a directory in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_dir_make_tmp().

      tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is null, a default template is used.

      Parameters:
      tmpl - Template for the file name, as in g_dir_make_tmp(), or null for a default template
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is done
      Since:
      2.74

    • newTmpDirFinish

      static File newTmpDirFinish(AsyncResult result) throws GErrorException
      Finishes a temporary directory creation started by g_file_new_tmp_dir_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      a new GFile. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.74

    • newTmpFinish

      static File newTmpFinish(AsyncResult result, Out<FileIOStream> iostream) throws GErrorException
      Finishes a temporary file creation started by g_file_new_tmp_async().
      Parameters:
      result - a GAsyncResult
      iostream - on return, a GFileIOStream for the created file
      Returns:
      a new GFile. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.74

    • parseName

      static File parseName(String parseName)
      Constructs a GFile with the given parseName (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the parseName cannot be parsed.
      Parameters:
      parseName - a file name or path to be parsed
      Returns:
      a new GFile.

    • appendTo

      default FileOutputStream appendTo(Set<FileCreateFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • appendTo

      default FileOutputStream appendTo(FileCreateFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • appendToAsync

      default void appendToAsync(Set<FileCreateFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously opens this File for appending.

      For more details, see g_file_append_to() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_append_to_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • appendToAsync

      default void appendToAsync(FileCreateFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously opens this File for appending.

      For more details, see g_file_append_to() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_append_to_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • appendToFinish

      default FileOutputStream appendToFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file append operation started with g_file_append_to_async().
      Parameters:
      res - GAsyncResult
      Returns:
      a valid GFileOutputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • buildAttributeListForCopy

      default String buildAttributeListForCopy(Set<FileCopyFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

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

      Parameters:
      flags - a set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      an attribute query string for g_file_query_info(), or null if an error occurs.
      Throws:
      GErrorException - see GError
      Since:
      2.68

    • buildAttributeListForCopy

      default String buildAttributeListForCopy(FileCopyFlags flags, @Nullable Cancellable cancellable) throws GErrorException

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

      Parameters:
      flags - a set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      an attribute query string for g_file_query_info(), or null if an error occurs.
      Throws:
      GErrorException - see GError
      Since:
      2.68

    • copy

      default boolean copy(File destination, Set<FileCopyFlags> flags, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback) throws GErrorException

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

      If the flag FileCopyFlags.OVERWRITE is specified an already existing destination file is overwritten.

      If the flag FileCopyFlags.NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the this File symlink will be copied.

      If the flag FileCopyFlags.ALL_METADATA 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 IOErrorEnum.CANCELLED will be returned.

      If progressCallback is not null, then the operation can be monitored by setting this to a GFileProgressCallback function. progressCallbackData will be passed to this function. It is guaranteed that this callback will be called after all data has been transferred with the total number of bytes copied during the operation.

      If the this File file does not exist, then the IOErrorEnum.NOT_FOUND error is returned, independent on the status of the destination.

      If FileCopyFlags.OVERWRITE is not specified and the target exists, then the error IOErrorEnum.EXISTS is returned.

      If trying to overwrite a file over a directory, the IOErrorEnum.IS_DIRECTORY error is returned. If trying to overwrite a directory with a directory the IOErrorEnum.WOULD_MERGE error is returned.

      If the source is a directory and the target does not exist, or FileCopyFlags.OVERWRITE is specified and the target is a file, then the IOErrorEnum.WOULD_RECURSE error is returned.

      If you are interested in copying the GFile object itself (not the on-disk file), see g_file_dup().

      Parameters:
      destination - destination GFile
      flags - set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      progressCallback - function to callback with progress information, or null if progress information is not needed
      Returns:
      true on success, false otherwise.
      Throws:
      GErrorException - see GError

    • copy

      default boolean copy(File destination, FileCopyFlags flags, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback) throws GErrorException

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

      If the flag FileCopyFlags.OVERWRITE is specified an already existing destination file is overwritten.

      If the flag FileCopyFlags.NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the this File symlink will be copied.

      If the flag FileCopyFlags.ALL_METADATA 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 IOErrorEnum.CANCELLED will be returned.

      If progressCallback is not null, then the operation can be monitored by setting this to a GFileProgressCallback function. progressCallbackData will be passed to this function. It is guaranteed that this callback will be called after all data has been transferred with the total number of bytes copied during the operation.

      If the this File file does not exist, then the IOErrorEnum.NOT_FOUND error is returned, independent on the status of the destination.

      If FileCopyFlags.OVERWRITE is not specified and the target exists, then the error IOErrorEnum.EXISTS is returned.

      If trying to overwrite a file over a directory, the IOErrorEnum.IS_DIRECTORY error is returned. If trying to overwrite a directory with a directory the IOErrorEnum.WOULD_MERGE error is returned.

      If the source is a directory and the target does not exist, or FileCopyFlags.OVERWRITE is specified and the target is a file, then the IOErrorEnum.WOULD_RECURSE error is returned.

      If you are interested in copying the GFile object itself (not the on-disk file), see g_file_dup().

      Parameters:
      destination - destination GFile
      flags - set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      progressCallback - function to callback with progress information, or null if progress information is not needed
      Returns:
      true on success, false otherwise.
      Throws:
      GErrorException - see GError

    • copyAsync

      default void copyAsync(File destination, Set<FileCopyFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

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

      If progressCallback is not null, then that function that will be called just like in g_file_copy(). The callback will run in the default main context of the thread calling g_file_copy_async() — the same context as callback is run in.

      When the operation is finished, callback will be called. You can then call g_file_copy_finish() to get the result of the operation.

      Parameters:
      destination - destination GFile
      flags - set of GFileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      progressCallback - function to callback with progress information, or null if progress information is not needed
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • copyAsync

      default void copyAsync(File destination, FileCopyFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

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

      If progressCallback is not null, then that function that will be called just like in g_file_copy(). The callback will run in the default main context of the thread calling g_file_copy_async() — the same context as callback is run in.

      When the operation is finished, callback will be called. You can then call g_file_copy_finish() to get the result of the operation.

      Parameters:
      destination - destination GFile
      flags - set of GFileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      progressCallback - function to callback with progress information, or null if progress information is not needed
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • copyAsyncWithClosures

      default void copyAsyncWithClosures(File destination, Set<FileCopyFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable Closure progressCallbackClosure, Closure readyCallbackClosure)
      Version of copyAsync(File, Set, int, Cancellable, FileProgressCallback, AsyncReadyCallback) using closures instead of callbacks for easier binding in other languages.
      Parameters:
      destination - destination Gio.File
      flags - set of Gio.FileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional Cancellable object, NULL to ignore
      progressCallbackClosure - GObject.Closure to invoke with progress information, or NULL if progress information is not needed
      readyCallbackClosure - GObject.Closure to invoke when the request is satisfied
      Since:
      2.82

    • copyAsyncWithClosures

      default void copyAsyncWithClosures(File destination, FileCopyFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable Closure progressCallbackClosure, Closure readyCallbackClosure)
      Version of copyAsync(File, Set, int, Cancellable, FileProgressCallback, AsyncReadyCallback) using closures instead of callbacks for easier binding in other languages.
      Parameters:
      destination - destination Gio.File
      flags - set of Gio.FileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional Cancellable object, NULL to ignore
      progressCallbackClosure - GObject.Closure to invoke with progress information, or NULL if progress information is not needed
      readyCallbackClosure - GObject.Closure to invoke when the request is satisfied
      Since:
      2.82

    • copyAttributes

      default boolean copyAttributes(File destination, Set<FileCopyFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Copies the file attributes from this File 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 FileCopyFlags.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.

      Parameters:
      destination - a GFile to copy attributes to
      flags - a set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attributes were copied successfully, false otherwise.
      Throws:
      GErrorException - see GError

    • copyAttributes

      default boolean copyAttributes(File destination, FileCopyFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Copies the file attributes from this File 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 FileCopyFlags.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.

      Parameters:
      destination - a GFile to copy attributes to
      flags - a set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attributes were copied successfully, false otherwise.
      Throws:
      GErrorException - see GError

    • copyFinish

      default boolean copyFinish(AsyncResult res) throws GErrorException
      Finishes copying the file started with g_file_copy_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a true on success, false on error.
      Throws:
      GErrorException - see GError

    • create

      default FileOutputStream create(Set<FileCreateFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream for the newly created file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • create

      default FileOutputStream create(FileCreateFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream for the newly created file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • createAsync

      default void createAsync(Set<FileCreateFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_create() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_create_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • createAsync

      default void createAsync(FileCreateFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_create() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_create_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • createFinish

      default FileOutputStream createFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file create operation started with g_file_create_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileOutputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • createReadwrite

      default FileIOStream createReadwrite(Set<FileCreateFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileIOStream for the newly created file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • createReadwrite

      default FileIOStream createReadwrite(FileCreateFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileIOStream for the newly created file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • createReadwriteAsync

      default void createReadwriteAsync(Set<FileCreateFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_create_readwrite() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_create_readwrite_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • createReadwriteAsync

      default void createReadwriteAsync(FileCreateFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_create_readwrite() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_create_readwrite_finish() to get the result of the operation.

      Parameters:
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • createReadwriteFinish

      default FileIOStream createReadwriteFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file create operation started with g_file_create_readwrite_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileIOStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • delete

      default boolean delete(@Nullable Cancellable cancellable) throws GErrorException

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

      If this File doesn’t exist, IOErrorEnum.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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the file was deleted. false otherwise.
      Throws:
      GErrorException - see GError

    • deleteAsync

      default void deleteAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously delete a file. If the this File is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink().
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.34

    • deleteFinish

      default boolean deleteFinish(AsyncResult result) throws GErrorException
      Finishes deleting a file started with g_file_delete_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      true if the file was deleted. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.34

    • dup

      default File 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.

      Returns:
      a new GFile that is a duplicate of the given GFile.

    • ejectMountable

      @Deprecated default void ejectMountable(Set<MountUnmountFlags> flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Deprecated.
      Use g_file_eject_mountable_with_operation() instead.

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

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • ejectMountable

      @Deprecated default void ejectMountable(MountUnmountFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Deprecated.
      Use g_file_eject_mountable_with_operation() instead.

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

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • ejectMountableFinish

      @Deprecated default boolean ejectMountableFinish(AsyncResult result) throws GErrorException
      Deprecated.
      Use g_file_eject_mountable_with_operation_finish() instead.
      Finishes an asynchronous eject operation started by g_file_eject_mountable().
      Parameters:
      result - a GAsyncResult
      Returns:
      true if the this File was ejected successfully. false otherwise.
      Throws:
      GErrorException - see GError

    • ejectMountableWithOperation

      default void ejectMountableWithOperation(Set<MountUnmountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • ejectMountableWithOperation

      default void ejectMountableWithOperation(MountUnmountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • ejectMountableWithOperationFinish

      default boolean ejectMountableWithOperationFinish(AsyncResult result) throws GErrorException
      Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation().
      Parameters:
      result - a GAsyncResult
      Returns:
      true if the this File was ejected successfully. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • enumerateChildren

      default FileEnumerator enumerateChildren(String attributes, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

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

      The 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 FILE_ATTRIBUTE_STANDARD_NAME. FILE_ATTRIBUTE_STANDARD_NAME should always be specified if you plan to call FileEnumerator.getChild(FileInfo) or FileEnumerator.iterate(Out, Out, Cancellable) 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.IOErrorEnum.CANCELLED will be returned.

      If the file does not exist, the Gio.IOErrorEnum.NOT_FOUND error will be returned. If the file is not a directory, the Gio.IOErrorEnum.NOT_DIRECTORY error will be returned. Other errors are possible too.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      A GFileEnumerator if successful, null on error. Free the returned object with GObject#unref.
      Throws:
      GErrorException - see GError

    • enumerateChildren

      default FileEnumerator enumerateChildren(String attributes, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

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

      The 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 FILE_ATTRIBUTE_STANDARD_NAME. FILE_ATTRIBUTE_STANDARD_NAME should always be specified if you plan to call FileEnumerator.getChild(FileInfo) or FileEnumerator.iterate(Out, Out, Cancellable) 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.IOErrorEnum.CANCELLED will be returned.

      If the file does not exist, the Gio.IOErrorEnum.NOT_FOUND error will be returned. If the file is not a directory, the Gio.IOErrorEnum.NOT_DIRECTORY error will be returned. Other errors are possible too.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      A GFileEnumerator if successful, null on error. Free the returned object with GObject#unref.
      Throws:
      GErrorException - see GError

    • enumerateChildrenAsync

      default void enumerateChildrenAsync(String attributes, Set<FileQueryInfoFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_enumerate_children() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_enumerate_children_finish() to get the result of the operation.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • enumerateChildrenAsync

      default void enumerateChildrenAsync(String attributes, FileQueryInfoFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_enumerate_children() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_enumerate_children_finish() to get the result of the operation.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • enumerateChildrenFinish

      default FileEnumerator enumerateChildrenFinish(AsyncResult res) throws GErrorException
      Finishes an async enumerate children operation. See g_file_enumerate_children_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileEnumerator or null if an error occurred. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • equal

      default boolean equal(File file2)

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

      This function can be used with hash() to insert Files 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 Files 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 Gio.FILE_ATTRIBUTE_ID_FILE.

      This call does no blocking I/O.

      Parameters:
      file2 - the second GFile
      Returns:
      true if this File and file2 are equal.

    • findEnclosingMount

      default Mount findEnclosingMount(@Nullable Cancellable cancellable) throws GErrorException

      Gets a GMount for the GFile.

      GMount is returned only for user interesting locations, see GVolumeMonitor. If the GFileIface for this File does not have a mount, error will be set to IOErrorEnum.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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GMount where the this File is located or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • findEnclosingMountAsync

      default void findEnclosingMountAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously gets the mount for the file.

      For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_find_enclosing_mount_finish() to get the result of the operation.

      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • findEnclosingMountFinish

      default Mount findEnclosingMountFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      GMount for given this File or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • getBasename

      default @Nullable String getBasename()

      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.

      Returns:
      string containing the GFile's base name, or null if given GFile is invalid. The returned string should be freed with g_free() when no longer needed.

    • getChild

      default File getChild(String name)

      Gets a child of this 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.

      Parameters:
      name - string containing the child's basename
      Returns:
      a GFile to a child specified by name. Free the returned object with g_object_unref().

    • getChildForDisplayName

      default File getChildForDisplayName(String displayName) throws GErrorException

      Gets the child of this File for a given displayName (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.

      Parameters:
      displayName - string to a possible child
      Returns:
      a GFile to the specified child, or null if the display name couldn't be converted. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • getParent

      default @Nullable File getParent()

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

      This call does no blocking I/O.

      Returns:
      a GFile structure to the parent of the given GFile or null if there is no parent. Free the returned object with g_object_unref().

    • getParseName

      default String getParseName()

      Gets the parse name of the file. A parse name is a UTF-8 string that describes the file such that one can get the GFile back using g_file_parse_name().

      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.

      Returns:
      a string containing the GFile's parse name. The returned string should be freed with g_free() when no longer needed.

    • getPath

      default @Nullable String getPath()

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

      This call does no blocking I/O.

      Returns:
      string containing the GFile's path, or null if no such path exists. The returned string should be freed with g_free() when no longer needed.

    • getRelativePath

      default @Nullable String getRelativePath(File descendant)

      Gets the path for descendant relative to parent.

      This call does no blocking I/O.

      Parameters:
      descendant - input GFile
      Returns:
      string with the relative path from descendant to parent, or null if descendant doesn't have this File as prefix. The returned string should be freed with g_free() when no longer needed.

    • getUri

      default String getUri()

      Gets the URI for the file.

      This call does no blocking I/O.

      Returns:
      a string containing the GFile's URI. If the GFile was constructed with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed.

    • getUriScheme

      default @Nullable String getUriScheme()

      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.

      Returns:
      a string containing the URI scheme for the given GFile or null if the GFile was constructed with an invalid URI. The returned string should be freed with g_free() when no longer needed.

    • hasParent

      default boolean hasParent(@Nullable File parent)

      Checks if this File has a parent, and optionally, if it is parent.

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

      Parameters:
      parent - the parent to check for, or null
      Returns:
      true if this File is an immediate child of parent (or any parent in the case that parent is null).
      Since:
      2.24

    • hasPrefix

      default boolean hasPrefix(File prefix)

      Checks whether this 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 this File is inside a prefix (from a filesystem point of view), because the prefix of this File is an alias of prefix.

      Parameters:
      prefix - input GFile
      Returns:
      true if the file's parent, grandparent, etc is prefix, false otherwise.

    • hasUriScheme

      default boolean hasUriScheme(String uriScheme)

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

      This call does no blocking I/O.

      Parameters:
      uriScheme - a string containing a URI scheme
      Returns:
      true if GFile's backend supports the given URI scheme, false if URI scheme is null, not supported, or GFile is invalid.

    • hash

      default int hash()

      Creates a hash value for a GFile.

      This call does no blocking I/O.

      Returns:
      0 if this File is not a valid GFile, otherwise an integer that can be used as hash value for the GFile. This function is intended for easily hashing a GFile to add to a GHashTable or similar data structure.

    • isNative

      default boolean isNative()

      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.

      Returns:
      true if this File is native

    • loadBytes

      default byte[] loadBytes(@Nullable Cancellable cancellable, @Nullable Out<String> etagOut) throws GErrorException

      Loads the contents of this File and returns it as GBytes.

      If this File is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling g_file_load_contents() and g_bytes_new_take().

      For resources, etagOut 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 g_bytes_unref() when no longer in use.

      Parameters:
      cancellable - a GCancellable or null
      etagOut - a location to place the current entity tag for the file, or null if the entity tag is not needed
      Returns:
      a GBytes or null and error is set
      Throws:
      GErrorException - see GError
      Since:
      2.56

    • loadBytesAsync

      default void loadBytesAsync(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously loads the contents of this File as GBytes.

      If this File is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling g_file_load_contents_async() and g_bytes_new_take().

      callback should call g_file_load_bytes_finish() to get the result of this asynchronous operation.

      See g_file_load_bytes() for more information.

      Parameters:
      cancellable - a GCancellable or null
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.56

    • loadBytesFinish

      default byte[] loadBytesFinish(AsyncResult result, @Nullable Out<String> etagOut) throws GErrorException

      Completes an asynchronous request to g_file_load_bytes_async().

      For resources, etagOut 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 g_bytes_unref() when no longer in use.

      See g_file_load_bytes() for more information.

      Parameters:
      result - a GAsyncResult provided to the callback
      etagOut - a location to place the current entity tag for the file, or null if the entity tag is not needed
      Returns:
      a GBytes or null and error is set
      Throws:
      GErrorException - see GError
      Since:
      2.56

    • loadContents

      default boolean loadContents(@Nullable Cancellable cancellable, @Nullable Out<byte[]> contents, @Nullable Out<String> etagOut) throws GErrorException

      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 g_free() 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      contents - a location to place the contents of the file
      etagOut - a location to place the current entity tag for the file, or null if the entity tag is not needed
      Returns:
      true if the file's contents were successfully loaded. false if there were errors.
      Throws:
      GErrorException - see GError

    • loadContentsAsync

      default void loadContentsAsync(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Starts an asynchronous load of the file's contents.

      For more details, see g_file_load_contents() 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 g_file_load_contents_finish() 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • loadContentsFinish

      default boolean loadContentsFinish(AsyncResult res, @Nullable Out<byte[]> contents, @Nullable Out<String> etagOut) throws GErrorException
      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 g_free() when no longer needed. If etagOut is present, it will be set to the new entity tag for the file.
      Parameters:
      res - a GAsyncResult
      contents - a location to place the contents of the file
      etagOut - a location to place the current entity tag for the file, or null if the entity tag is not needed
      Returns:
      true if the load was successful. If false and error is present, it will be set appropriately.
      Throws:
      GErrorException - see GError

    • loadPartialContentsAsync

      default void loadPartialContentsAsync(@Nullable Cancellable cancellable, @Nullable FileReadMoreCallback readMoreCallback, @Nullable AsyncReadyCallback callback)

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

      Users of this function should be aware that userData is passed to both the readMoreCallback and 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      readMoreCallback - a GFileReadMoreCallback to receive partial data and to specify whether further data should be read
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • loadPartialContentsFinish

      default boolean loadPartialContentsFinish(AsyncResult res, @Nullable Out<byte[]> contents, @Nullable Out<String> etagOut) throws GErrorException
      Finishes an asynchronous partial load operation that was started with g_file_load_partial_contents_async(). The data is always zero-terminated, but this is not included in the resultant length. The returned contents should be freed with g_free() when no longer needed.
      Parameters:
      res - a GAsyncResult
      contents - a location to place the contents of the file
      etagOut - a location to place the current entity tag for the file, or null if the entity tag is not needed
      Returns:
      true if the load was successful. If false and error is present, it will be set appropriately.
      Throws:
      GErrorException - see GError

    • makeDirectory

      default boolean makeDirectory(@Nullable Cancellable cancellable) throws GErrorException

      Creates a directory.

      Note that this will only create a child directory of the immediate parent directory of the path or URI given by the GFile. To recursively create directories, see g_file_make_directory_with_parents().

      This function will fail if the parent directory does not exist, setting error to IOErrorEnum.NOT_FOUND. If the file system doesn't support creating directories, this function will fail, setting error to IOErrorEnum.NOT_SUPPORTED. If the directory already exists, 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true on successful creation, false otherwise.
      Throws:
      GErrorException - see GError

    • makeDirectoryAsync

      default void makeDirectoryAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously creates a directory.
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.38

    • makeDirectoryFinish

      default boolean makeDirectoryFinish(AsyncResult result) throws GErrorException
      Finishes an asynchronous directory creation, started with g_file_make_directory_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      true on successful directory creation, false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.38

    • makeDirectoryWithParents

      default boolean makeDirectoryWithParents(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.NOT_SUPPORTED. If the directory itself already exists, this function will fail setting error to IOErrorEnum.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.

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if all directories have been successfully created, false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.18

    • makeSymbolicLink

      default boolean makeSymbolicLink(String symlinkValue, @Nullable Cancellable cancellable) throws GErrorException

      Creates a symbolic link named this File which contains the string symlinkValue.

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      symlinkValue - a string with the path for the target of the new symlink
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true on the creation of a new symlink, false otherwise.
      Throws:
      GErrorException - see GError

    • makeSymbolicLinkAsync

      default void makeSymbolicLinkAsync(String symlinkValue, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously creates a symbolic link named this File which contains the string symlinkValue.
      Parameters:
      symlinkValue - a string with the path for the target of the new symlink
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.74

    • makeSymbolicLinkFinish

      default boolean makeSymbolicLinkFinish(AsyncResult result) throws GErrorException
      Finishes an asynchronous symbolic link creation, started with g_file_make_symbolic_link_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      true on successful directory creation, false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.74

    • measureDiskUsage

      default boolean measureDiskUsage(Set<FileMeasureFlags> flags, @Nullable Cancellable cancellable, @Nullable FileMeasureProgressCallback progressCallback, @Nullable Out<Long> diskUsage, @Nullable Out<Long> numDirs, @Nullable Out<Long> numFiles) throws GErrorException

      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 FileMeasureFlags.REPORT_ANY_ERROR is given in flags.

      The returned size, diskUsage, is in bytes and should be formatted with g_format_size() in order to get something reasonable for showing in a user interface.

      progressCallback and progressData 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.

      Parameters:
      flags - GFileMeasureFlags
      cancellable - optional GCancellable
      progressCallback - a GFileMeasureProgressCallback
      diskUsage - the number of bytes of disk space used
      numDirs - the number of directories encountered
      numFiles - the number of non-directories encountered
      Returns:
      true if successful, with the out parameters set. false otherwise, with error set.
      Throws:
      GErrorException - see GError
      Since:
      2.38

    • measureDiskUsage

      default boolean measureDiskUsage(FileMeasureFlags flags, @Nullable Cancellable cancellable, @Nullable FileMeasureProgressCallback progressCallback, @Nullable Out<Long> diskUsage, @Nullable Out<Long> numDirs, @Nullable Out<Long> numFiles) throws GErrorException

      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 FileMeasureFlags.REPORT_ANY_ERROR is given in flags.

      The returned size, diskUsage, is in bytes and should be formatted with g_format_size() in order to get something reasonable for showing in a user interface.

      progressCallback and progressData 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.

      Parameters:
      flags - GFileMeasureFlags
      cancellable - optional GCancellable
      progressCallback - a GFileMeasureProgressCallback
      diskUsage - the number of bytes of disk space used
      numDirs - the number of directories encountered
      numFiles - the number of non-directories encountered
      Returns:
      true if successful, with the out parameters set. false otherwise, with error set.
      Throws:
      GErrorException - see GError
      Since:
      2.38

    • measureDiskUsageAsync

      default void measureDiskUsageAsync(Set<FileMeasureFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileMeasureProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

      Recursively measures the disk usage of file.

      This is the asynchronous version of g_file_measure_disk_usage(). See there for more information.

      Parameters:
      flags - GFileMeasureFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable
      progressCallback - a GFileMeasureProgressCallback
      callback - a GAsyncReadyCallback to call when complete
      Since:
      2.38

    • measureDiskUsageAsync

      default void measureDiskUsageAsync(FileMeasureFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileMeasureProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

      Recursively measures the disk usage of file.

      This is the asynchronous version of g_file_measure_disk_usage(). See there for more information.

      Parameters:
      flags - GFileMeasureFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable
      progressCallback - a GFileMeasureProgressCallback
      callback - a GAsyncReadyCallback to call when complete
      Since:
      2.38

    • measureDiskUsageFinish

      default boolean measureDiskUsageFinish(AsyncResult result, @Nullable Out<Long> diskUsage, @Nullable Out<Long> numDirs, @Nullable Out<Long> numFiles) throws GErrorException
      Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information.
      Parameters:
      result - the GAsyncResult passed to your GAsyncReadyCallback
      diskUsage - the number of bytes of disk space used
      numDirs - the number of directories encountered
      numFiles - the number of non-directories encountered
      Returns:
      true if successful, with the out parameters set. false otherwise, with error set.
      Throws:
      GErrorException - see GError
      Since:
      2.38

    • monitor

      default FileMonitor monitor(Set<FileMonitorFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.18

    • monitor

      default FileMonitor monitor(FileMonitorFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.18

    • monitorDirectory

      default FileMonitor monitorDirectory(Set<FileMonitorFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      It does not make sense for flags to contain FileMonitorFlags.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().

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • monitorDirectory

      default FileMonitor monitorDirectory(FileMonitorFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      It does not make sense for flags to contain FileMonitorFlags.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().

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • monitorFile

      default FileMonitor monitorFile(Set<FileMonitorFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      If flags contains FileMonitorFlags.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 this 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.

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • monitorFile

      default FileMonitor monitorFile(FileMonitorFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      If flags contains FileMonitorFlags.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 this 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.

      Parameters:
      flags - a set of GFileMonitorFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileMonitor for the given file, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • mountEnclosingVolume

      default void mountEnclosingVolume(Set<MountMountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      When this operation has completed, callback will be called with userUser data, and the operation can be finalized with g_file_mount_enclosing_volume_finish().

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null

    • mountEnclosingVolume

      default void mountEnclosingVolume(MountMountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      When this operation has completed, callback will be called with userUser data, and the operation can be finalized with g_file_mount_enclosing_volume_finish().

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null

    • mountEnclosingVolumeFinish

      default boolean mountEnclosingVolumeFinish(AsyncResult result) throws GErrorException
      Finishes a mount operation started by g_file_mount_enclosing_volume().
      Parameters:
      result - a GAsyncResult
      Returns:
      true if successful. If an error has occurred, this function will return false and set error appropriately if present.
      Throws:
      GErrorException - see GError

    • mountMountable

      default void mountMountable(Set<MountMountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using mountOperation, 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • mountMountable

      default void mountMountable(MountMountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using mountOperation, 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • mountMountableFinish

      default File mountMountableFinish(AsyncResult result) throws GErrorException

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

      Finish an asynchronous mount operation that was started with g_file_mount_mountable().

      Parameters:
      result - a GAsyncResult
      Returns:
      a GFile or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • move

      default boolean move(File destination, Set<FileCopyFlags> flags, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback) throws GErrorException

      Tries to move the file or directory this File 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 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 IOErrorEnum.CANCELLED will be returned.

      If progressCallback is not null, then the operation can be monitored by setting this to a GFileProgressCallback function. progressCallbackData will be passed to this function. It is guaranteed that this callback will be called after all data has been transferred with the total number of bytes copied during the operation.

      If the this File file does not exist, then the IOErrorEnum.NOT_FOUND error is returned, independent on the status of the destination.

      If FileCopyFlags.OVERWRITE is not specified and the target exists, then the error IOErrorEnum.EXISTS is returned.

      If trying to overwrite a file over a directory, the IOErrorEnum.IS_DIRECTORY error is returned. If trying to overwrite a directory with a directory the IOErrorEnum.WOULD_MERGE error is returned.

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

      Parameters:
      destination - GFile pointing to the destination location
      flags - set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      progressCallback - GFileProgressCallback function for updates
      Returns:
      true on successful move, false otherwise.
      Throws:
      GErrorException - see GError

    • move

      default boolean move(File destination, FileCopyFlags flags, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback) throws GErrorException

      Tries to move the file or directory this File 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 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 IOErrorEnum.CANCELLED will be returned.

      If progressCallback is not null, then the operation can be monitored by setting this to a GFileProgressCallback function. progressCallbackData will be passed to this function. It is guaranteed that this callback will be called after all data has been transferred with the total number of bytes copied during the operation.

      If the this File file does not exist, then the IOErrorEnum.NOT_FOUND error is returned, independent on the status of the destination.

      If FileCopyFlags.OVERWRITE is not specified and the target exists, then the error IOErrorEnum.EXISTS is returned.

      If trying to overwrite a file over a directory, the IOErrorEnum.IS_DIRECTORY error is returned. If trying to overwrite a directory with a directory the IOErrorEnum.WOULD_MERGE error is returned.

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

      Parameters:
      destination - GFile pointing to the destination location
      flags - set of GFileCopyFlags
      cancellable - optional GCancellable object, null to ignore
      progressCallback - GFileProgressCallback function for updates
      Returns:
      true on successful move, false otherwise.
      Throws:
      GErrorException - see GError

    • moveAsync

      default void moveAsync(File destination, Set<FileCopyFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

      Asynchronously moves a file this File to the location of destination. For details of the behaviour, see g_file_move().

      If progressCallback is not null, then that function that will be called just like in g_file_move(). The callback will run in the default main context of the thread calling g_file_move_async() — the same context as callback is run in.

      When the operation is finished, callback will be called. You can then call g_file_move_finish() to get the result of the operation.

      Parameters:
      destination - GFile pointing to the destination location
      flags - set of GFileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      progressCallback - GFileProgressCallback function for updates
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.72

    • moveAsync

      default void moveAsync(File destination, FileCopyFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)

      Asynchronously moves a file this File to the location of destination. For details of the behaviour, see g_file_move().

      If progressCallback is not null, then that function that will be called just like in g_file_move(). The callback will run in the default main context of the thread calling g_file_move_async() — the same context as callback is run in.

      When the operation is finished, callback will be called. You can then call g_file_move_finish() to get the result of the operation.

      Parameters:
      destination - GFile pointing to the destination location
      flags - set of GFileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      progressCallback - GFileProgressCallback function for updates
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.72

    • moveAsyncWithClosures

      default void moveAsyncWithClosures(File destination, Set<FileCopyFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable Closure progressCallbackClosure, Closure readyCallbackClosure)
      Version of moveAsync(File, Set, int, Cancellable, FileProgressCallback, AsyncReadyCallback) using closures instead of callbacks for easier binding in other languages.
      Parameters:
      destination - destination Gio.File
      flags - set of Gio.FileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional Cancellable object, NULL to ignore
      progressCallbackClosure - GObject.Closure to invoke with progress information, or NULL if progress information is not needed
      readyCallbackClosure - GObject.Closure to invoke when the request is satisfied
      Since:
      2.82

    • moveAsyncWithClosures

      default void moveAsyncWithClosures(File destination, FileCopyFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable Closure progressCallbackClosure, Closure readyCallbackClosure)
      Version of moveAsync(File, Set, int, Cancellable, FileProgressCallback, AsyncReadyCallback) using closures instead of callbacks for easier binding in other languages.
      Parameters:
      destination - destination Gio.File
      flags - set of Gio.FileCopyFlags
      ioPriority - the I/O priority of the request
      cancellable - optional Cancellable object, NULL to ignore
      progressCallbackClosure - GObject.Closure to invoke with progress information, or NULL if progress information is not needed
      readyCallbackClosure - GObject.Closure to invoke when the request is satisfied
      Since:
      2.82

    • moveFinish

      default boolean moveFinish(AsyncResult result) throws GErrorException
      Finishes an asynchronous file movement, started with g_file_move_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      true on successful file move, false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.72

    • openReadwrite

      default FileIOStream openReadwrite(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      If the file does not exist, the IOErrorEnum.NOT_FOUND error will be returned. If the file is a directory, the IOErrorEnum.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.

      Parameters:
      cancellable - a GCancellable
      Returns:
      GFileIOStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • openReadwriteAsync

      default void openReadwriteAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously opens this File for reading and writing.

      For more details, see g_file_open_readwrite() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_open_readwrite_finish() to get the result of the operation.

      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • openReadwriteFinish

      default FileIOStream openReadwriteFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file read operation started with g_file_open_readwrite_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileIOStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • peekPath

      default @Nullable String peekPath()

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

      This call does no blocking I/O.

      Returns:
      string containing the GFile's path, or null if no such path exists. The returned string is owned by file.
      Since:
      2.56

    • pollMountable

      default void pollMountable(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Polls a file of type 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null
      Since:
      2.22

    • pollMountableFinish

      default boolean pollMountableFinish(AsyncResult result) throws GErrorException

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

      Finish an asynchronous poll operation that was polled with g_file_poll_mountable().

      Parameters:
      result - a GAsyncResult
      Returns:
      true if the operation finished successfully. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • queryDefaultHandler

      default AppInfo queryDefaultHandler(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GAppInfo if the handle was found, null if there were errors. When you are done with it, release it with g_object_unref()
      Throws:
      GErrorException - see GError

    • queryDefaultHandlerAsync

      default void queryDefaultHandlerAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Async version of g_file_query_default_handler().
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is done
      Since:
      2.60

    • queryDefaultHandlerFinish

      default AppInfo queryDefaultHandlerFinish(AsyncResult result) throws GErrorException
      Finishes a g_file_query_default_handler_async() operation.
      Parameters:
      result - a GAsyncResult
      Returns:
      a GAppInfo if the handle was found, null if there were errors. When you are done with it, release it with g_object_unref()
      Throws:
      GErrorException - see GError
      Since:
      2.60

    • queryExists

      default boolean queryExists(@Nullable Cancellable cancellable)

      Utility function to check if a particular file exists.

      The fallback implementation of this API is using queryInfo(String, Set, Cancellable) and therefore may do blocking I/O. To asynchronously query the existence of a file, use queryInfoAsync(String, Set, int, Cancellable, AsyncReadyCallback).

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

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the file exists (and can be detected without error), false otherwise (or if cancelled).

    • queryFileType

      default FileType queryFileType(Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable)

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

      The primary use case of this method is to check if a file is a regular file, directory, or symlink.

      Parameters:
      flags - a set of GFileQueryInfoFlags passed to g_file_query_info()
      cancellable - optional GCancellable object, null to ignore
      Returns:
      The GFileType of the file and FileType.UNKNOWN if the file does not exist
      Since:
      2.18

    • queryFileType

      default FileType queryFileType(FileQueryInfoFlags flags, @Nullable Cancellable cancellable)

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

      The primary use case of this method is to check if a file is a regular file, directory, or symlink.

      Parameters:
      flags - a set of GFileQueryInfoFlags passed to g_file_query_info()
      cancellable - optional GCancellable object, null to ignore
      Returns:
      The GFileType of the file and FileType.UNKNOWN if the file does not exist
      Since:
      2.18

    • queryFilesystemInfo

      default FileInfo queryFilesystemInfo(String attributes, @Nullable Cancellable cancellable) throws GErrorException

      Similar to g_file_query_info(), but obtains information about the filesystem the this 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 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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      attributes - an attribute query string
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileInfo or null if there was an error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • queryFilesystemInfoAsync

      default void queryFilesystemInfoAsync(String attributes, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously gets the requested information about the filesystem that the specified this 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 g_file_query_filesystem_info() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_query_info_finish() to get the result of the operation.

      Parameters:
      attributes - an attribute query string
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • queryFilesystemInfoFinish

      default FileInfo queryFilesystemInfoFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      GFileInfo for given this File or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • queryInfo

      default FileInfo queryInfo(String attributes, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Gets the requested information about specified file.

      The result is a FileInfo object that contains key-value attributes (such as the type or size of the file).

      The 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 FileInfo to have very few attributes set. You should check whether an attribute is set using FileInfo.hasAttribute(String) before trying to retrieve its value.

      It is guaranteed that if any of the following attributes are listed in attributes, they will always be set in the returned FileInfo, even if the user doesn’t have permissions to access the file:

      • Gio.FILE_ATTRIBUTE_STANDARD_NAME
      • 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 Gio.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.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.FileQueryInfoFlags.NOFOLLOW_SYMLINKS 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.IOErrorEnum.NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of file system the file is on.

      Parameters:
      attributes - an attribute query string
      flags - flags to affect the query operation
      cancellable - optional cancellable object
      Returns:
      a FileInfo for the given this File
      Throws:
      GErrorException - see GError

    • queryInfo

      default FileInfo queryInfo(String attributes, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Gets the requested information about specified file.

      The result is a FileInfo object that contains key-value attributes (such as the type or size of the file).

      The 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 FileInfo to have very few attributes set. You should check whether an attribute is set using FileInfo.hasAttribute(String) before trying to retrieve its value.

      It is guaranteed that if any of the following attributes are listed in attributes, they will always be set in the returned FileInfo, even if the user doesn’t have permissions to access the file:

      • Gio.FILE_ATTRIBUTE_STANDARD_NAME
      • 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 Gio.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.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.FileQueryInfoFlags.NOFOLLOW_SYMLINKS 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.IOErrorEnum.NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of file system the file is on.

      Parameters:
      attributes - an attribute query string
      flags - flags to affect the query operation
      cancellable - optional cancellable object
      Returns:
      a FileInfo for the given this File
      Throws:
      GErrorException - see GError

    • queryInfoAsync

      default void queryInfoAsync(String attributes, Set<FileQueryInfoFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_query_info() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_query_info_finish() to get the result of the operation.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • queryInfoAsync

      default void queryInfoAsync(String attributes, FileQueryInfoFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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 g_file_query_info() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_query_info_finish() to get the result of the operation.

      Parameters:
      attributes - an attribute query string
      flags - a set of GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • queryInfoFinish

      default FileInfo queryInfoFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file info query. See g_file_query_info_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      GFileInfo for given this File or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • querySettableAttributes

      default FileAttributeInfoList querySettableAttributes(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref()
      Throws:
      GErrorException - see GError

    • queryWritableNamespaces

      default FileAttributeInfoList queryWritableNamespaces(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref()
      Throws:
      GErrorException - see GError

    • read

      default FileInputStream read(@Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      cancellable - a GCancellable
      Returns:
      GFileInputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • readAsync

      default void readAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously opens this File for reading.

      For more details, see g_file_read() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_read_finish() to get the result of the operation.

      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • readFinish

      default FileInputStream readFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file read operation started with g_file_read_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileInputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • replace

      default FileOutputStream replace(@Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

      If you pass in a non-null etag value and this File already exists, then this value is compared to the current entity tag of the file, and if they differ an IOErrorEnum.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 makeBackup is true, this function will attempt to make a backup of the current file before overwriting it. If this fails a IOErrorEnum.CANT_CREATE_BACKUP error will be returned. If you want to replace anyway, try again with makeBackup set to false.

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

      Parameters:
      etag - an optional entity tag for the current GFile, or NULL to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • replace

      default FileOutputStream replace(@Nullable String etag, boolean makeBackup, FileCreateFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 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 IOErrorEnum.CANCELLED will be returned.

      If you pass in a non-null etag value and this File already exists, then this value is compared to the current entity tag of the file, and if they differ an IOErrorEnum.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 makeBackup is true, this function will attempt to make a backup of the current file before overwriting it. If this fails a IOErrorEnum.CANT_CREATE_BACKUP error will be returned. If you want to replace anyway, try again with makeBackup set to false.

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

      Parameters:
      etag - an optional entity tag for the current GFile, or NULL to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileOutputStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • replaceAsync

      default void replaceAsync(@Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_replace() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_replace_finish() to get the result of the operation.

      Parameters:
      etag - an entity tag for the current GFile, or null to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • replaceAsync

      default void replaceAsync(@Nullable String etag, boolean makeBackup, FileCreateFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_replace() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_replace_finish() to get the result of the operation.

      Parameters:
      etag - an entity tag for the current GFile, or null to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • replaceContents

      default boolean replaceContents(@Nullable byte @Nullable [] contents, @Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, @Nullable Out<String> newEtag, @Nullable Cancellable cancellable) throws GErrorException

      Replaces the contents of this File with contents of length bytes.

      If etag is specified (not null), any existing file must have that etag, or the error IOErrorEnum.WRONG_ETAG will be returned.

      If makeBackup is true, this function will attempt to make a backup of file. Internally, it uses g_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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      contents - a string containing the new contents for this File
      etag - the old entity-tag for the document, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      newEtag - a location to a new entity tag for the document. This should be freed with g_free() when no longer needed, or null
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if successful. If an error has occurred, this function will return false and set error appropriately if present.
      Throws:
      GErrorException - see GError

    • replaceContents

      default boolean replaceContents(@Nullable byte @Nullable [] contents, @Nullable String etag, boolean makeBackup, FileCreateFlags flags, @Nullable Out<String> newEtag, @Nullable Cancellable cancellable) throws GErrorException

      Replaces the contents of this File with contents of length bytes.

      If etag is specified (not null), any existing file must have that etag, or the error IOErrorEnum.WRONG_ETAG will be returned.

      If makeBackup is true, this function will attempt to make a backup of file. Internally, it uses g_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 IOErrorEnum.CANCELLED will be returned.

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

      Parameters:
      contents - a string containing the new contents for this File
      etag - the old entity-tag for the document, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      newEtag - a location to a new entity tag for the document. This should be freed with g_free() when no longer needed, or null
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if successful. If an error has occurred, this function will return false and set error appropriately if present.
      Throws:
      GErrorException - see GError

    • replaceContentsAsync

      default void replaceContentsAsync(@Nullable byte @Nullable [] contents, @Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Starts an asynchronous replacement of this 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 userUser data, and the operation can be finalized with g_file_replace_contents_finish().

      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 IOErrorEnum.CANCELLED will be returned.

      If makeBackup 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 g_file_replace_contents_bytes_async() for a GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

      Parameters:
      contents - string of contents to replace the file with
      etag - a new entity tag for the file, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • replaceContentsAsync

      default void replaceContentsAsync(@Nullable byte @Nullable [] contents, @Nullable String etag, boolean makeBackup, FileCreateFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Starts an asynchronous replacement of this 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 userUser data, and the operation can be finalized with g_file_replace_contents_finish().

      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 IOErrorEnum.CANCELLED will be returned.

      If makeBackup 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 g_file_replace_contents_bytes_async() for a GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

      Parameters:
      contents - string of contents to replace the file with
      etag - a new entity tag for the file, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • replaceContentsBytesAsync

      default void replaceContentsBytesAsync(byte[] contents, @Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      When this operation has completed, callback will be called with userUser data, and the operation can be finalized with g_file_replace_contents_finish().

      Parameters:
      contents - a GBytes
      etag - a new entity tag for the file, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.40

    • replaceContentsBytesAsync

      default void replaceContentsBytesAsync(byte[] contents, @Nullable String etag, boolean makeBackup, FileCreateFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      When this operation has completed, callback will be called with userUser data, and the operation can be finalized with g_file_replace_contents_finish().

      Parameters:
      contents - a GBytes
      etag - a new entity tag for the file, or null
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.40

    • replaceContentsFinish

      default boolean replaceContentsFinish(AsyncResult res, @Nullable Out<String> newEtag) throws GErrorException
      Finishes an asynchronous replace of the given file. See g_file_replace_contents_async(). Sets newEtag to the new entity tag for the document, if present.
      Parameters:
      res - a GAsyncResult
      newEtag - a location of a new entity tag for the document. This should be freed with g_free() when it is no longer needed, or null
      Returns:
      true on success, false on failure.
      Throws:
      GErrorException - see GError

    • replaceFinish

      default FileOutputStream replaceFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file replace operation started with g_file_replace_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileOutputStream, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • replaceReadwrite

      default FileIOStream replaceReadwrite(@Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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.

      Parameters:
      etag - an optional entity tag for the current GFile, or NULL to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileIOStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • replaceReadwrite

      default FileIOStream replaceReadwrite(@Nullable String etag, boolean makeBackup, FileCreateFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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.

      Parameters:
      etag - an optional entity tag for the current GFile, or NULL to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFileIOStream or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • replaceReadwriteAsync

      default void replaceReadwriteAsync(@Nullable String etag, boolean makeBackup, Set<FileCreateFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_replace_readwrite() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_replace_readwrite_finish() to get the result of the operation.

      Parameters:
      etag - an entity tag for the current GFile, or null to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • replaceReadwriteAsync

      default void replaceReadwriteAsync(@Nullable String etag, boolean makeBackup, FileCreateFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

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

      For more details, see g_file_replace_readwrite() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_replace_readwrite_finish() to get the result of the operation.

      Parameters:
      etag - an entity tag for the current GFile, or null to ignore
      makeBackup - true if a backup should be created
      flags - a set of GFileCreateFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • replaceReadwriteFinish

      default FileIOStream replaceReadwriteFinish(AsyncResult res) throws GErrorException
      Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFileIOStream, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • resolveRelativePath

      default File resolveRelativePath(String relativePath)

      Resolves a relative path for this File to an absolute path.

      This call does no blocking I/O.

      If the relativePath is an absolute path name, the resolution is done absolutely (without taking this File path as base).

      Parameters:
      relativePath - a given relative path string
      Returns:
      a GFile for the resolved path.

    • setAttribute

      default boolean setAttribute(String attribute, FileAttributeType type, @Nullable MemorySegment valueP, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

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

      Some attributes can be unset by setting type to FileAttributeType.INVALID and valueP 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      type - The type of the attribute
      valueP - a pointer to the value (or the pointer itself if the type is a pointer type)
      flags - a set of GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttribute

      default boolean setAttribute(String attribute, FileAttributeType type, @Nullable MemorySegment valueP, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

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

      Some attributes can be unset by setting type to FileAttributeType.INVALID and valueP 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      type - The type of the attribute
      valueP - a pointer to the value (or the pointer itself if the type is a pointer type)
      flags - a set of GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeByteString

      default boolean setAttributeByteString(String attribute, String value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type FileAttributeType.BYTE_STRING 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a string containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeByteString

      default boolean setAttributeByteString(String attribute, String value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type FileAttributeType.BYTE_STRING 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a string containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeInt32

      default boolean setAttributeInt32(String attribute, int value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a gint32 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeInt32

      default boolean setAttributeInt32(String attribute, int value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a gint32 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeInt64

      default boolean setAttributeInt64(String attribute, long value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint64 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeInt64

      default boolean setAttributeInt64(String attribute, long value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint64 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeString

      default boolean setAttributeString(String attribute, String value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a string containing the attribute's value
      flags - GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeString

      default boolean setAttributeString(String attribute, String value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a string containing the attribute's value
      flags - GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeUint32

      default boolean setAttributeUint32(String attribute, int value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint32 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeUint32

      default boolean setAttributeUint32(String attribute, int value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint32 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeUint64

      default boolean setAttributeUint64(String attribute, long value, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint64 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributeUint64

      default boolean setAttributeUint64(String attribute, long value, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      Sets attribute of type 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      attribute - a string containing the attribute's name
      value - a guint64 containing the attribute's new value
      flags - a GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true if the attribute was successfully set to value in the file, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributesAsync

      default void setAttributesAsync(FileInfo info, Set<FileQueryInfoFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously sets the attributes of this File with info.

      For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_set_attributes_finish() to get the result of the operation.

      Parameters:
      info - a GFileInfo
      flags - a GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • setAttributesAsync

      default void setAttributesAsync(FileInfo info, FileQueryInfoFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously sets the attributes of this File with info.

      For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_set_attributes_finish() to get the result of the operation.

      Parameters:
      info - a GFileInfo
      flags - a GFileQueryInfoFlags
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • setAttributesFinish

      default boolean setAttributesFinish(AsyncResult result, Out<FileInfo> info) throws GErrorException
      Finishes setting an attribute started in g_file_set_attributes_async().
      Parameters:
      result - a GAsyncResult
      info - a GFileInfo
      Returns:
      true if the attributes were set correctly, false otherwise.
      Throws:
      GErrorException - see GError

    • setAttributesFromInfo

      default boolean setAttributesFromInfo(FileInfo info, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable) throws GErrorException

      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 FileAttributeStatus.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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      info - a GFileInfo
      flags - GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      false if there was any error, true otherwise.
      Throws:
      GErrorException - see GError

    • setAttributesFromInfo

      default boolean setAttributesFromInfo(FileInfo info, FileQueryInfoFlags flags, @Nullable Cancellable cancellable) throws GErrorException

      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 FileAttributeStatus.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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      info - a GFileInfo
      flags - GFileQueryInfoFlags
      cancellable - optional GCancellable object, null to ignore
      Returns:
      false if there was any error, true otherwise.
      Throws:
      GErrorException - see GError

    • setDisplayName

      default File setDisplayName(String displayName, @Nullable Cancellable cancellable) throws GErrorException

      Renames this 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 this 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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      displayName - a string
      cancellable - optional GCancellable object, null to ignore
      Returns:
      a GFile specifying what this File was renamed to, or null if there was an error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • setDisplayNameAsync

      default void setDisplayNameAsync(String displayName, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Asynchronously sets the display name for a given GFile.

      For more details, see g_file_set_display_name() which is the synchronous version of this call.

      When the operation is finished, callback will be called. You can then call g_file_set_display_name_finish() to get the result of the operation.

      Parameters:
      displayName - a string
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • setDisplayNameFinish

      default File setDisplayNameFinish(AsyncResult res) throws GErrorException
      Finishes setting a display name started with g_file_set_display_name_async().
      Parameters:
      res - a GAsyncResult
      Returns:
      a GFile or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError

    • startMountable

      default void startMountable(Set<DriveStartFlags> flags, @Nullable MountOperation startOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Starts a file of type FileType.MOUNTABLE. Using startOperation, 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      startOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null
      Since:
      2.22

    • startMountable

      default void startMountable(DriveStartFlags flags, @Nullable MountOperation startOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Starts a file of type FileType.MOUNTABLE. Using startOperation, 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      startOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null
      Since:
      2.22

    • startMountableFinish

      default boolean startMountableFinish(AsyncResult result) throws GErrorException

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

      Finish an asynchronous start operation that was started with g_file_start_mountable().

      Parameters:
      result - a GAsyncResult
      Returns:
      true if the operation finished successfully. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • stopMountable

      default void stopMountable(Set<MountUnmountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Stops a file of type 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_stop_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction.
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null
      Since:
      2.22

    • stopMountable

      default void stopMountable(MountUnmountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Stops a file of type 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_stop_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction.
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied, or null
      Since:
      2.22

    • stopMountableFinish

      default boolean stopMountableFinish(AsyncResult result) throws GErrorException

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

      Finish an asynchronous stop operation that was started with g_file_stop_mountable().

      Parameters:
      result - a GAsyncResult
      Returns:
      true if the operation finished successfully. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • supportsThreadContexts

      default boolean supportsThreadContexts()
      Checks if this File supports thread-default main contexts (see MainContext#pushThreadDefault) If this returns false, you cannot perform asynchronous operations on this File in a thread that has a thread-default context.
      Returns:
      Whether or not this File supports thread-default contexts.
      Since:
      2.22

    • trash

      default boolean trash(@Nullable Cancellable cancellable) throws GErrorException

      Sends this 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 IOErrorEnum.NOT_SUPPORTED error. Since GLib 2.66, the x-gvfs-notrash unix mount option can be used to disable g_file_trash() support for particular mounts, the IOErrorEnum.NOT_SUPPORTED error will be returned in that case. Since 2.82, the x-gvfs-trash unix mount option can be used to enable g_file_trash() support for particular system mounts.

      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 IOErrorEnum.CANCELLED will be returned.

      Parameters:
      cancellable - optional GCancellable object, null to ignore
      Returns:
      true on successful trash, false otherwise.
      Throws:
      GErrorException - see GError

    • trashAsync

      default void trashAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously sends this File to the Trash location, if possible.
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.38

    • trashFinish

      default boolean trashFinish(AsyncResult result) throws GErrorException
      Finishes an asynchronous file trashing operation, started with g_file_trash_async().
      Parameters:
      result - a GAsyncResult
      Returns:
      true on successful trash, false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.38

    • unmountMountable

      @Deprecated default void unmountMountable(Set<MountUnmountFlags> flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Deprecated.
      Use g_file_unmount_mountable_with_operation() instead.

      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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • unmountMountable

      @Deprecated default void unmountMountable(MountUnmountFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Deprecated.
      Use g_file_unmount_mountable_with_operation() instead.

      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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied

    • unmountMountableFinish

      @Deprecated default boolean unmountMountableFinish(AsyncResult result) throws GErrorException
      Deprecated.
      Use g_file_unmount_mountable_with_operation_finish() instead.

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

      Finish an asynchronous unmount operation that was started with g_file_unmount_mountable().

      Parameters:
      result - a GAsyncResult
      Returns:
      true if the operation finished successfully. false otherwise.
      Throws:
      GErrorException - see GError

    • unmountMountableWithOperation

      default void unmountMountableWithOperation(Set<MountUnmountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Unmounts a file of type 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • unmountMountableWithOperation

      default void unmountMountableWithOperation(MountUnmountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      Unmounts a file of type 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 IOErrorEnum.CANCELLED will be returned.

      When the operation is finished, callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation.

      Parameters:
      flags - flags affecting the operation
      mountOperation - a GMountOperation, or null to avoid user interaction
      cancellable - optional GCancellable object, null to ignore
      callback - a GAsyncReadyCallback to call when the request is satisfied
      Since:
      2.22

    • unmountMountableWithOperationFinish

      default boolean unmountMountableWithOperationFinish(AsyncResult result) throws GErrorException

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

      Parameters:
      result - a GAsyncResult
      Returns:
      true if the operation finished successfully. false otherwise.
      Throws:
      GErrorException - see GError
      Since:
      2.22