FileEnumerator

FileEnumerator

Object Hierarchy:

Description:

[ CCode ( type_id = "g_file_enumerator_get_type ()" ) ]
public class FileEnumerator : Object

`GFileEnumerator` allows you to operate on a set of [iface@Gio.

File] objects, returning a [class@Gio.FileInfo] structure for each file enumerated (e.g. [method@Gio.File.enumerate_children] will return a `GFileEnumerator` for each of the children within a directory).

To get the next file's information from a `GFileEnumerator`, use [method@Gio.FileEnumerator.next_file] or its asynchronous version, [ method@Gio.FileEnumerator.next_files_async]. Note that the asynchronous version will return a list of [class@Gio.FileInfo] objects, 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 [method@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 `GFileEnumerator`, use [method@Gio.FileEnumerator.close], or its asynchronous version, [method@Gio.FileEnumerator.close_async] . Once a `GFileEnumerator` is closed, no further actions may be performed on it, and it should be freed with [method@GObject.Object.unref] .

Namespace: GLib

Package: gio-2.0

Content:

Properties:

public File container { construct; }
The container that is being enumerated.

Creation methods:

protected FileEnumerator ()

Methods:

public bool close (Cancellable? cancellable = null) throws Error
Releases all resources used by this enumerator, making the enumerator return g_io_error_closed on all calls.
public virtual async bool close_async (int io_priority = DEFAULT, Cancellable? cancellable = null) throws Error
Asynchronously closes the file enumerator.
public virtual bool close_fn (Cancellable? cancellable = null) throws Error
public File get_child (FileInfo info)
Return a new File which refers to the file named by info in the source directory of this.
public unowned File get_container ()
Get the File container which is being enumerated.
public bool has_pending ()
Checks if the file enumerator has pending operations.
public bool is_closed ()
Checks if the file enumerator has been closed.
public bool iterate (out unowned FileInfo out_info, out unowned File out_child, Cancellable? cancellable = null) throws Error
This is a version of next_file that's easier to use correctly from C programs.
public virtual FileInfo? next_file (Cancellable? cancellable = null) throws Error
Returns information for the next file in the enumerated object.
public virtual async List<FileInfo> next_files_async (int num_files, int io_priority = DEFAULT, Cancellable? cancellable = null) throws Error
Request information for a number of files from the enumerator asynchronously.
public void set_pending (bool pending)
Sets the file enumerator as having pending operations.

Inherited Members:

All known members inherited from class GLib.Object