DBusError#

Added in version 2.26.

class DBusError#

Error codes for the %G_DBUS_ERROR error domain.

Methods#

class DBusError
encode_gerror() → str#

Creates a D-Bus error name to use for error. If error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned.

Otherwise the a name of the form org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE will be used. This allows other GDBus applications to map the error on the wire back to a Error using g_dbus_error_new_for_dbus_error().

This function is typically only used in object mappings to put a Error on the wire. Regular applications should not use it.

Added in version 2.26.

get_remote_error() → str | None#

Gets the D-Bus error name used for error, if any.

This function is guaranteed to return a D-Bus error name for all Error returned from functions handling remote method calls (e.g. call_finish()) unless g_dbus_error_strip_remote_error() has been used on error.

Added in version 2.26.

is_remote_error() → bool#

Checks if error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error.

Added in version 2.26.

new_for_dbus_error(dbus_error_message: str) → GError#

Creates a Error based on the contents of dbus_error_name and dbus_error_message.

Errors registered with g_dbus_error_register_error() will be looked up using dbus_error_name and if a match is found, the error domain and code is used. Applications can use g_dbus_error_get_remote_error() to recover dbus_error_name.

If a match against a registered error is not found and the D-Bus error name is in a form as returned by g_dbus_error_encode_gerror() the error domain and code encoded in the name is used to create the Error. Also, dbus_error_name is added to the error message such that it can be recovered with g_dbus_error_get_remote_error().

Otherwise, a Error with the error code DBUS_ERROR in the %G_IO_ERROR error domain is returned. Also, dbus_error_name is added to the error message such that it can be recovered with g_dbus_error_get_remote_error().

In all three cases, dbus_error_name can always be recovered from the returned Error using the g_dbus_error_get_remote_error() function (unless g_dbus_error_strip_remote_error() hasn’t been used on the returned error).

This function is typically only used in object mappings to prepare Error instances for applications. Regular applications should not use it.

Added in version 2.26.

Parameters:

dbus_error_message – D-Bus error message.

quark() → int#
register_error(error_code: int, dbus_error_name: str) → bool#

Creates an association to map between dbus_error_name and Error specified by error_domain and error_code.

This is typically done in the routine that returns the Quark for an error domain.

Added in version 2.26.

Parameters:

  • error_code – An error code.

  • dbus_error_name – A D-Bus error name.

register_error_domain(quark_volatile: int, entries: list[DBusErrorEntry]) → None#

Helper function for associating a Error error domain with D-Bus error names.

While quark_volatile has a volatile qualifier, this is a historical artifact and the argument passed to it should not be volatile.

Added in version 2.26.

Parameters:

  • quark_volatile – A pointer where to store the Quark.

  • entries – A pointer to num_entries DBusErrorEntry struct items.

strip_remote_error() → bool#

Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in error will correspond exactly to what was received on the wire.

This is typically used when presenting errors to the end user.

Added in version 2.26.

unregister_error(error_code: int, dbus_error_name: str) → bool#

Destroys an association previously set up with g_dbus_error_register_error().

Added in version 2.26.

Parameters:

  • error_code – An error code.

  • dbus_error_name – A D-Bus error name.

Fields#

class DBusError
ACCESS_DENIED#

The type of the None singleton.

ADDRESS_IN_USE#

The type of the None singleton.

ADT_AUDIT_DATA_UNKNOWN#

The type of the None singleton.

AUTH_FAILED#

The type of the None singleton.

BAD_ADDRESS#

The type of the None singleton.

DISCONNECTED#

The type of the None singleton.

FAILED#

The type of the None singleton.

FILE_EXISTS#

The type of the None singleton.

FILE_NOT_FOUND#

The type of the None singleton.

INVALID_ARGS#

The type of the None singleton.

INVALID_FILE_CONTENT#

The type of the None singleton.

INVALID_SIGNATURE#

The type of the None singleton.

IO_ERROR#

The type of the None singleton.

LIMITS_EXCEEDED#

The type of the None singleton.

MATCH_RULE_INVALID#

The type of the None singleton.

MATCH_RULE_NOT_FOUND#

The type of the None singleton.

NAME_HAS_NO_OWNER#

The type of the None singleton.

NOT_SUPPORTED#

The type of the None singleton.

NO_MEMORY#

The type of the None singleton.

NO_NETWORK#

The type of the None singleton.

NO_REPLY#

The type of the None singleton.

NO_SERVER#

The type of the None singleton.

OBJECT_PATH_IN_USE#

The type of the None singleton.

PROPERTY_READ_ONLY#

The type of the None singleton.

SELINUX_SECURITY_CONTEXT_UNKNOWN#

The type of the None singleton.

SERVICE_UNKNOWN#

The type of the None singleton.

SPAWN_CHILD_EXITED#

The type of the None singleton.

SPAWN_CHILD_SIGNALED#

The type of the None singleton.

SPAWN_CONFIG_INVALID#

The type of the None singleton.

SPAWN_EXEC_FAILED#

The type of the None singleton.

SPAWN_FAILED#

The type of the None singleton.

SPAWN_FILE_INVALID#

The type of the None singleton.

SPAWN_FORK_FAILED#

The type of the None singleton.

SPAWN_NO_MEMORY#

The type of the None singleton.

SPAWN_PERMISSIONS_INVALID#

The type of the None singleton.

SPAWN_SERVICE_INVALID#

The type of the None singleton.

SPAWN_SERVICE_NOT_FOUND#

The type of the None singleton.

SPAWN_SETUP_FAILED#

The type of the None singleton.

TIMED_OUT#

The type of the None singleton.

TIMEOUT#

The type of the None singleton.

UNIX_PROCESS_ID_UNKNOWN#

The type of the None singleton.

UNKNOWN_INTERFACE#

The type of the None singleton.

UNKNOWN_METHOD#

The type of the None singleton.

UNKNOWN_OBJECT#

The type of the None singleton.

UNKNOWN_PROPERTY#

The type of the None singleton.