Module: Gio::Initable

Defined in:

(unknown)

Overview

GInitable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via [methodGio.Initable.init] or [methodGio.AsyncInitable.init_async] (the latter is only available if it also implements [ifaceGio.AsyncInitable]).

If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with [funcGLib.critical] or [funcGLib.warning], but this must not be relied on.

Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call [funcGio.Initable.new] directly, or indirectly via a foo_thing_new() wrapper. This will call [methodGio.Initable.init] under the cover, returning NULL and setting a GError on failure (at which point the instance is unreferenced).

For bindings in languages where the native constructor supports exceptions the binding could check for objects implementing GInitable during normal construction and automatically initialize them, throwing an exception on failure.

Instance Method Summary

• #init(initable, cancellable) ⇒ Boolean

  True if successful.

Instance Method Details

#init(initable, cancellable) ⇒ Boolean

True if successful. If an error has occurred, this function will return false and set error appropriately if present.

Parameters:

• initable (Gio::Initable) —

  a #GInitable.

• cancellable (Gio::Cancellable) —

  optional #GCancellable object, nil to ignore.

Returns:

• (Boolean) —

  true if successful. If an error has occurred, this function will return false and set error appropriately if present.