Interface

GioInitable

Description [src]

interface Gio.Initable : GObject.Object

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 g_initable_init() or g_async_initable_init_async() (the latter is only available if it also implements GAsyncInitable).

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 g_critical() or g_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 g_initable_new() directly, or indirectly via a foo_thing_new() wrapper. This will call g_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.

Available since:2.22

Prerequisite

In order to implement Initable, your type must inherit from GObject.

Functions

g_initable_new

Helper function for constructing GInitable object. This is similar to g_object_new() but also initializes the object and returns NULL, setting an error on failure.

g_initable_new_valist

Helper function for constructing GInitable object. This is similar to g_object_new_valist() but also initializes the object and returns NULL, setting an error on failure.

g_initable_newv

Helper function for constructing GInitable object. This is similar to g_object_newv() but also initializes the object and returns NULL, setting an error on failure.

Deprecated since:

Instance methods

g_initable_init

Initializes the object implementing the interface.

Available since: 2.22

Interface structure

struct GioInitableIface {
  GTypeInterface g_iface;
  gboolean (* init) (
    GInitable* initable,
    GCancellable* cancellable,
    GError** error
  );
  
}
Interface members
g_iface
GTypeInterface
 

The parent interface.

init
gboolean (* init) (
    GInitable* initable,
    GCancellable* cancellable,
    GError** error
  )
 No description available.

Virtual methods

Gio.Initable.init

Initializes the object implementing the interface.