Memory-managed wrapper type.

Type class for types which can be safely cast to FileEnumerator, for instance with toFileEnumerator.

Cast to FileEnumerator, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe FileEnumerator.

Releases all resources used by this enumerator, making the enumerator return IOErrorEnumClosed on all calls.

This will be automatically called when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.

Asynchronously closes the file enumerator.

If cancellable is not Nothing, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnumCancelled will be returned in fileEnumeratorCloseFinish.

Finishes closing a file enumerator, started from fileEnumeratorCloseAsync.

If the file enumerator was already closed when fileEnumeratorCloseAsync was called, then this function will report IOErrorEnumClosed in error, and return False. If the file enumerator had pending operation when the close operation was started, then this function will report IOErrorEnumPending, and return False. If cancellable was not Nothing, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnumCancelled will be set, and False will be returned.

Return a new File which refers to the file named by info in the source directory of enumerator. This function is primarily intended to be used inside loops with fileEnumeratorNextFile.

This is a convenience method that's equivalent to:

C code

 gchar *name = g_file_info_get_name (info);
 GFile *child = g_file_get_child (g_file_enumerator_get_container (enumr),
                                  name);

Since: 2.36

Get the File container which is being enumerated.

Since: 2.18

Checks if the file enumerator has pending operations.

Checks if the file enumerator has been closed.

This is a version of fileEnumeratorNextFile that's easier to use correctly from C programs. With fileEnumeratorNextFile, the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary GError.

In contrast, with this function, a False return from fileEnumeratorIterate *always* means "error". End of iteration is signaled by outInfo or outChild being Nothing.

Another crucial difference is that the references for outInfo and outChild are owned by direnum (they are cached as hidden properties). You must not unref them in your own code. This makes memory management significantly easier for C code in combination with loops.

Finally, this function optionally allows retrieving a File as well.

You must specify at least one of outInfo or outChild.

The code pattern for correctly using fileEnumeratorIterate from C is:

direnum = g_file_enumerate_children (file, ...);
while (TRUE)
  {
    GFileInfo *info;
    if (!g_file_enumerator_iterate (direnum, &info, NULL, cancellable, error))
      goto out;
    if (!info)
      break;
    ... do stuff with "info"; do not unref it! ...
  }

out:
  g_object_unref (direnum); // Note: frees the last @info

Since: 2.44

Returns information for the next file in the enumerated object. Will block until the information is available. The FileInfo returned from this function will contain attributes that match the attribute string that was passed when the FileEnumerator was created.

See the documentation of FileEnumerator for information about the order of returned files.

On error, returns Nothing and sets error to the error. If the enumerator is at the end, Nothing will be returned and error will be unset.

Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the callback will be called with the requested information.

See the documentation of FileEnumerator for information about the order of returned files.

The callback can be called with less than numFiles files in case of error or at the end of the enumerator. In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. If a request is cancelled the callback will be called with IOErrorEnumCancelled.

During an async request no other sync and async calls are allowed, and will result in IOErrorEnumPending errors.

Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is PRIORITY_DEFAULT.

Finishes the asynchronous operation started with fileEnumeratorNextFilesAsync.

Sets the file enumerator as having pending operations.

Construct a GValueConstruct with valid value for the “container” property. This is rarely needed directly, but it is used by new.