FileEnumerator

gio.file_enumerator.FileEnumerator allows you to operate on a set of gio.file.File objects, returning a gio.file_info.FileInfo structure for each file enumerated (e.g. gio.file.File.enumerateChildren will return a gio.file_enumerator.FileEnumerator for each of the children within a directory).

To get the next file's information from a gio.file_enumerator.FileEnumerator, use gio.file_enumerator.FileEnumerator.nextFile or its asynchronous version, gio.file_enumerator.FileEnumerator.nextFilesAsync. Note that the asynchronous version will return a list of gio.file_info.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 glib.dir.Dir.readName. 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.file_enumerator.FileEnumerator, use gio.file_enumerator.FileEnumerator.close, or its asynchronous version, gio.file_enumerator.FileEnumerator.closeAsync. Once a gio.file_enumerator.FileEnumerator is closed, no further actions may be performed on it, and it should be freed with gobject.object.ObjectG.unref.

class FileEnumerator : ObjectG {

bool close(gio.cancellable.Cancellable cancellable);

void closeAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

bool closeFinish(gio.async_result.AsyncResult result);

gio.file.File getChild(gio.file_info.FileInfo info);

gio.file.File getContainer();

bool hasPending();

bool isClosed();

bool iterate(gio.file_info.FileInfo outInfo, gio.file.File outChild, gio.cancellable.Cancellable cancellable);

gio.file_info.FileInfo nextFile(gio.cancellable.Cancellable cancellable);

void nextFilesAsync(int numFiles, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.file_info.FileInfo[] nextFilesFinish(gio.async_result.AsyncResult result);

void setPending(bool pending);

}

Members

Functions

close bool close(gio.cancellable.Cancellable cancellable): Releases all resources used by this enumerator, making the enumerator return gio.types.IOErrorEnum.Closed on all calls.
closeAsync void closeAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): Asynchronously closes the file enumerator.
closeFinish bool closeFinish(gio.async_result.AsyncResult result): Finishes closing a file enumerator, started from gio.file_enumerator.FileEnumerator.closeAsync.
getChild gio.file.File getChild(gio.file_info.FileInfo info): Return a new #GFile 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 gio.file_enumerator.FileEnumerator.nextFile.
getContainer gio.file.File getContainer(): Get the #GFile container which is being enumerated.
hasPending bool hasPending(): Checks if the file enumerator has pending operations.
isClosed bool isClosed(): Checks if the file enumerator has been closed.
iterate bool iterate(gio.file_info.FileInfo outInfo, gio.file.File outChild, gio.cancellable.Cancellable cancellable): This is a version of gio.file_enumerator.FileEnumerator.nextFile that's easier to use correctly from C programs. With gio.file_enumerator.FileEnumerator.nextFile, the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary #GError.
nextFile gio.file_info.FileInfo nextFile(gio.cancellable.Cancellable cancellable): Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created.
nextFilesAsync void nextFilesAsync(int numFiles, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): 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.
nextFilesFinish gio.file_info.FileInfo[] nextFilesFinish(gio.async_result.AsyncResult result): Finishes the asynchronous operation started with gio.file_enumerator.FileEnumerator.nextFilesAsync.
setPending void setPending(bool pending): Sets the file enumerator as having pending operations.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gio file_enumerator classes

FileEnumerator