Gio.File.prototype.replace

function replace(etag: String, make_backup: Boolean, flags: Gio.FileCreateFlags, cancellable: Gio.Cancellable): Gio.FileOutputStream {
    // Gjs wrapper for g_file_replace()
}
  

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

This will try to replace the file in the safest way possible so that any errors during the writing will not affect an already existing copy of the file. For instance, for local files it may write to a temporary file and then atomically rename over the destination when the stream is closed.

By default files created are generally readable by everyone, but if you pass #G_FILE_CREATE_PRIVATE in flags the file will be made readable only to the current user, to the level that is supported on the target filesystem.

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

If you pass in a non-null etag value, then this value is compared to the current entity tag of the file, and if they differ an Gio.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 Gio.FileOutputStream.prototype.get_etag after you've finished writing and closed the Gio.FileOutputStream. When you load a new file you can use Gio.FileInputStream.prototype.query_info to get the etag of the file.

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

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