Gio.FileEnumerator

g GObject.Object GObject.Object Gio.FileEnumerator Gio.FileEnumerator GObject.Object->Gio.FileEnumerator

Subclasses

None

Methods

Inherited

GObject.Object (37)

Structs

GObject.ObjectClass (5)

close (cancellable)

close_async (io_priority, cancellable, callback, *user_data)

close_finish (result)

get_child (info)

get_container ()

has_pending ()

is_closed ()

iterate (cancellable)

next ()

next_file (cancellable)

next_files_async (num_files, io_priority, cancellable, callback, *user_data)

next_files_finish (result)

set_pending (pending)

Virtual Methods

Inherited

GObject.Object (7)

do_close_async (io_priority, cancellable, callback, *user_data)

do_close_finish (result)

do_close_fn (cancellable)

do_next_file (cancellable)

do_next_files_async (num_files, io_priority, cancellable, callback, *user_data)

do_next_files_finish (result)

Properties

Name

Type

Flags

Short Description

container

Gio.File

w/co

The container that is being enumerated

Signals

Inherited

GObject.Object (1)

Fields

Inherited

GObject.Object (1)

Name

Type

Access

Description

parent_instance

GObject.Object

r

Class Details

class Gio.FileEnumerator(**kwargs)
Bases

GObject.Object

Abstract

No

Structure

Gio.FileEnumeratorClass

Gio.FileEnumerator allows you to operate on a set of Gio.Files, returning a Gio.FileInfo structure for each file enumerated (e.g. Gio.File.enumerate_children() will return a Gio.FileEnumerator for each of the children within a directory).

To get the next file’s information from a Gio.FileEnumerator, use Gio.FileEnumerator.next_file() or its asynchronous version, Gio.FileEnumerator.next_files_async(). Note that the asynchronous version will return a list of Gio.FileInfos, whereas the synchronous will only return the next file in the enumerator.

The ordering of returned files is unspecified for non-Unix platforms; for more information, see GLib.Dir.read_name(). On Unix, when operating on local files, returned files will be sorted by inode number. Effectively you can assume that the ordering of returned files will be stable between successive calls (and applications) assuming the directory is unchanged.

If your application needs a specific ordering, such as by name or modification time, you will have to implement that in your application code.

To close a Gio.FileEnumerator, use Gio.FileEnumerator.close(), or its asynchronous version, Gio.FileEnumerator.close_async(). Once a Gio.FileEnumerator is closed, no further actions may be performed on it, and it should be freed with GObject.Object.unref().

close(cancellable)[source]
Parameters

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

Raises

GLib.Error

Returns

True on success or False on error.

Return type

bool

Releases all resources used by this enumerator, making the enumerator return Gio.IOErrorEnum.CLOSED 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.

close_async(io_priority, cancellable, callback, *user_data)[source]
Parameters

Asynchronously closes the file enumerator.

If cancellable is not None, 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 in Gio.FileEnumerator.close_finish().

close_finish(result)[source]
Parameters

result (Gio.AsyncResult) – a Gio.AsyncResult.

Raises

GLib.Error

Returns

True if the close operation has finished successfully.

Return type

bool

Finishes closing a file enumerator, started from Gio.FileEnumerator.close_async().

If the file enumerator was already closed when Gio.FileEnumerator.close_async() was called, then this function will report Gio.IOErrorEnum.CLOSED in error, and return False. If the file enumerator had pending operation when the close operation was started, then this function will report Gio.IOErrorEnum.PENDING, and return False. If cancellable was not None, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be set, and False will be returned.

get_child(info)[source]
Parameters

info (Gio.FileInfo) – a Gio.FileInfo gotten from Gio.FileEnumerator.next_file() or the async equivalents.

Returns

a Gio.File for the Gio.FileInfo passed it.

Return type

Gio.File

Return a new Gio.File which refers to the file named by info in the source directory of self. This function is primarily intended to be used inside loops with Gio.FileEnumerator.next_file().

To use this, Gio.FILE_ATTRIBUTE_STANDARD_NAME must have been listed in the attributes list used when creating the Gio.FileEnumerator.

This is a convenience method that’s equivalent to:

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

New in version 2.36.

get_container()[source]
Returns

the Gio.File which is being enumerated.

Return type

Gio.File

Get the Gio.File container which is being enumerated.

New in version 2.18.

has_pending()[source]
Returns

True if the self has pending operations.

Return type

bool

Checks if the file enumerator has pending operations.

is_closed()[source]
Returns

True if the self is closed.

Return type

bool

Checks if the file enumerator has been closed.

iterate(cancellable)[source]
Parameters

cancellable (Gio.Cancellable or None) – a Gio.Cancellable

Raises

GLib.Error

Returns

out_info

Output location for the next Gio.FileInfo, or None

out_child

Output location for the next Gio.File, or None

Return type

(bool, out_info: Gio.FileInfo, out_child: Gio.File)

This is a version of Gio.FileEnumerator.next_file() that’s easier to use correctly from C programs. With Gio.FileEnumerator.next_file(), the bool return value signifies “end of iteration or error”, which requires allocation of a temporary GLib.Error.

In contrast, with this function, a False return from Gio.FileEnumerator.iterate() *always* means “error”. End of iteration is signaled by out_info or out_child being None.

Another crucial difference is that the references for out_info and out_child are owned by self (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 Gio.File as well.

You must specify at least one of out_info or out_child.

The code pattern for correctly using Gio.FileEnumerator.iterate() 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

New in version 2.44.

next()
next_file(cancellable)[source]
Parameters

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

Raises

GLib.Error

Returns

A Gio.FileInfo or None on error or end of enumerator. Free the returned object with GObject.Object.unref() when no longer needed.

Return type

Gio.FileInfo or None

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

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

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

next_files_async(num_files, io_priority, cancellable, callback, *user_data)[source]
Parameters

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 Gio.FileEnumerator for information about the order of returned files.

Once the end of the enumerator is reached, or if an error occurs, the callback will be called with an empty list. In this case, the previous call to Gio.FileEnumerator.next_files_async() will typically have returned fewer than num_files items.

If a request is cancelled the callback will be called with Gio.IOErrorEnum.CANCELLED.

This leads to the following pseudo-code usage:

g_autoptr(GFile) dir = get_directory ();
g_autoptr(GFileEnumerator) enumerator = NULL;
g_autolist(GFileInfo) files = NULL;
g_autoptr(GError) local_error = NULL;

enumerator = yield g_file_enumerate_children_async (dir,
                                                    G_FILE_ATTRIBUTE_STANDARD_NAME ","
                                                    G_FILE_ATTRIBUTE_STANDARD_TYPE,
                                                    G_FILE_QUERY_INFO_NONE,
                                                    G_PRIORITY_DEFAULT,
                                                    cancellable,
                                                    …,
                                                    &local_error);
if (enumerator == NULL)
  g_error ("Error enumerating: %s", local_error->message);

// Loop until no files are returned, either because the end of the enumerator
// has been reached, or an error was returned.
do
  {
    files = yield g_file_enumerator_next_files_async (enumerator,
                                                      5,  // number of files to request
                                                      G_PRIORITY_DEFAULT,
                                                      cancellable,
                                                      …,
                                                      &local_error);

    // Process the returned files, but don’t assume that exactly 5 were returned.
    for (GList *l = files; l != NULL; l = l->next)
      {
        GFileInfo *info = l->data;
        handle_file_info (info);
      }
  }
while (files != NULL);

if (local_error != NULL &&
    !g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  g_error ("Error while enumerating: %s", local_error->message);

During an async request no other sync and async calls are allowed, and will result in Gio.IOErrorEnum.PENDING 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 GLib.PRIORITY_DEFAULT.

next_files_finish(result)[source]
Parameters

result (Gio.AsyncResult) – a Gio.AsyncResult.

Raises

GLib.Error

Returns

a GLib.List of Gio.FileInfos. You must free the list with g_list_free() and unref the infos with GObject.Object.unref() when you’re done with them.

Return type

[Gio.FileInfo]

Finishes the asynchronous operation started with Gio.FileEnumerator.next_files_async().

set_pending(pending)[source]
Parameters

pending (bool) – a boolean value.

Sets the file enumerator as having pending operations.

do_close_async(io_priority, cancellable, callback, *user_data) virtual
Parameters

Asynchronously closes the file enumerator.

If cancellable is not None, 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 in Gio.FileEnumerator.close_finish().

do_close_finish(result) virtual
Parameters

result (Gio.AsyncResult) – a Gio.AsyncResult.

Returns

True if the close operation has finished successfully.

Return type

bool

Finishes closing a file enumerator, started from Gio.FileEnumerator.close_async().

If the file enumerator was already closed when Gio.FileEnumerator.close_async() was called, then this function will report Gio.IOErrorEnum.CLOSED in error, and return False. If the file enumerator had pending operation when the close operation was started, then this function will report Gio.IOErrorEnum.PENDING, and return False. If cancellable was not None, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be set, and False will be returned.

do_close_fn(cancellable) virtual
Parameters

cancellable (Gio.Cancellable or None) –

Return type

bool

do_next_file(cancellable) virtual
Parameters

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

Returns

A Gio.FileInfo or None on error or end of enumerator. Free the returned object with GObject.Object.unref() when no longer needed.

Return type

Gio.FileInfo or None

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

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

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

do_next_files_async(num_files, io_priority, cancellable, callback, *user_data) virtual
Parameters

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 Gio.FileEnumerator for information about the order of returned files.

Once the end of the enumerator is reached, or if an error occurs, the callback will be called with an empty list. In this case, the previous call to Gio.FileEnumerator.next_files_async() will typically have returned fewer than num_files items.

If a request is cancelled the callback will be called with Gio.IOErrorEnum.CANCELLED.

This leads to the following pseudo-code usage:

g_autoptr(GFile) dir = get_directory ();
g_autoptr(GFileEnumerator) enumerator = NULL;
g_autolist(GFileInfo) files = NULL;
g_autoptr(GError) local_error = NULL;

enumerator = yield g_file_enumerate_children_async (dir,
                                                    G_FILE_ATTRIBUTE_STANDARD_NAME ","
                                                    G_FILE_ATTRIBUTE_STANDARD_TYPE,
                                                    G_FILE_QUERY_INFO_NONE,
                                                    G_PRIORITY_DEFAULT,
                                                    cancellable,
                                                    …,
                                                    &local_error);
if (enumerator == NULL)
  g_error ("Error enumerating: %s", local_error->message);

// Loop until no files are returned, either because the end of the enumerator
// has been reached, or an error was returned.
do
  {
    files = yield g_file_enumerator_next_files_async (enumerator,
                                                      5,  // number of files to request
                                                      G_PRIORITY_DEFAULT,
                                                      cancellable,
                                                      …,
                                                      &local_error);

    // Process the returned files, but don’t assume that exactly 5 were returned.
    for (GList *l = files; l != NULL; l = l->next)
      {
        GFileInfo *info = l->data;
        handle_file_info (info);
      }
  }
while (files != NULL);

if (local_error != NULL &&
    !g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  g_error ("Error while enumerating: %s", local_error->message);

During an async request no other sync and async calls are allowed, and will result in Gio.IOErrorEnum.PENDING 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 GLib.PRIORITY_DEFAULT.

do_next_files_finish(result) virtual
Parameters

result (Gio.AsyncResult) – a Gio.AsyncResult.

Returns

a GLib.List of Gio.FileInfos. You must free the list with g_list_free() and unref the infos with GObject.Object.unref() when you’re done with them.

Return type

[Gio.FileInfo]

Finishes the asynchronous operation started with Gio.FileEnumerator.next_files_async().

Property Details

Gio.FileEnumerator.props.container
Name

container

Type

Gio.File

Default Value

None

Flags

WRITABLE, CONSTRUCT_ONLY

The container that is being enumerated