Class (GI Struct)

Gio-2.0 ▶ Gio ▶ IOErrorEnum

Error codes returned by GIO functions.

Note that this domain may be extended in future GLib releases. In general, new error codes either only apply to new APIs, or else replace Gio.IOErrorEnum.FAILED in cases that were not explicitly distinguished before. You should therefore avoid writing code like

if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_FAILED))
  {
    // Assume that this is EPRINTERONFIRE
    ...
  }

but should instead treat all unrecognized error codes the same as Gio.IOErrorEnum.FAILED.

See also Gio.PollableReturn for a cheaper way of returning Gio.IOErrorEnum.WOULD_BLOCK to callers without allocating a GLib.Error.

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

$gtype ADDRESS_IN_USE ALREADY_MOUNTED BROKEN_PIPE BUSY CANCELLED CANT_CREATE_BACKUP CLOSED CONNECTION_CLOSED CONNECTION_REFUSED DBUS_ERROR DESTINATION_UNSET EXISTS FAILED FAILED_HANDLED FILENAME_TOO_LONG HOST_NOT_FOUND HOST_UNREACHABLE INVALID_ARGUMENT INVALID_DATA INVALID_FILENAME IS_DIRECTORY MESSAGE_TOO_LARGE NETWORK_UNREACHABLE NO_SPACE NO_SUCH_DEVICE NOT_CONNECTED NOT_DIRECTORY NOT_EMPTY NOT_FOUND NOT_INITIALIZED NOT_MOUNTABLE_FILE NOT_MOUNTED NOT_REGULAR_FILE NOT_SUPPORTED NOT_SYMBOLIC_LINK PARTIAL_INPUT PENDING PERMISSION_DENIED PROXY_AUTH_FAILED PROXY_FAILED PROXY_NEED_AUTH PROXY_NOT_ALLOWED READ_ONLY TIMED_OUT TOO_MANY_LINKS TOO_MANY_OPEN_FILES WOULD_BLOCK WOULD_MERGE WOULD_RECURSE WRONG_ETAG

Properties - Inherited from GLib

code domain message stack

Methods - Inherited from GLib

copy free matches domain_register domain_register_static new_literal

Constructors

Properties

$gtype: GType<GLib.Error>
ADDRESS_IN_USE: number

The requested address is already in use. Since 2.22

ALREADY_MOUNTED: number

File is already mounted.

BROKEN_PIPE: number

Broken pipe. Since 2.36

BUSY: number

File is busy.

CANCELLED: number

Operation was cancelled. See Gio.Cancellable.

CANT_CREATE_BACKUP: number

Backup couldn't be created.

CLOSED: number

File was closed.

CONNECTION_CLOSED: number

Connection closed by peer. Note that this is the same code as Gio.IOErrorEnum.BROKEN_PIPE; before 2.44 some "connection closed" errors returned Gio.IOErrorEnum.BROKEN_PIPE, but others returned Gio.IOErrorEnum.FAILED. Now they should all return the same value, which has this more logical name. Since 2.44.

CONNECTION_REFUSED: number

Connection refused. Since 2.26

DBUS_ERROR: number

A remote object generated an error that doesn't correspond to a locally registered GLib.Error error domain. Use g_dbus_error_get_remote_error() to extract the D-Bus error name and g_dbus_error_strip_remote_error() to fix up the message so it matches what was received on the wire. Since 2.26.

DESTINATION_UNSET: number

Destination address unset. Since 2.80

EXISTS: number

File already exists.

FAILED: number

Generic error condition for when an operation fails and no more specific Gio.IOErrorEnum value is defined.

FAILED_HANDLED: number

Operation failed and a helper program has already interacted with the user. Do not display any error dialog.

FILENAME_TOO_LONG: number

Filename is too many characters.

HOST_NOT_FOUND: number

Host couldn't be found (remote operations).

HOST_UNREACHABLE: number

Host unreachable. Since 2.26

INVALID_ARGUMENT: number

Invalid argument.

INVALID_DATA: number

The input data was invalid. Since 2.24

INVALID_FILENAME: number

Filename is invalid or contains invalid characters.

IS_DIRECTORY: number

File is a directory.

MESSAGE_TOO_LARGE: number

Message too large. Since 2.48.

NETWORK_UNREACHABLE: number

Network unreachable. Since 2.26

NO_SPACE: number

No space left on drive.

NO_SUCH_DEVICE: number

No such device found. Since 2.74

NOT_CONNECTED: number

Transport endpoint is not connected. Since 2.44

NOT_DIRECTORY: number

File is not a directory.

NOT_EMPTY: number

File is a directory that isn't empty.

NOT_FOUND: number

File not found.

NOT_INITIALIZED: number

The object has not been initialized. Since 2.22

NOT_MOUNTABLE_FILE: number

File cannot be mounted.

NOT_MOUNTED: number

File isn't mounted.

NOT_REGULAR_FILE: number

File is not a regular file.

NOT_SUPPORTED: number

Operation (or one of its parameters) not supported

NOT_SYMBOLIC_LINK: number

File is not a symbolic link.

PARTIAL_INPUT: number

Need more input to finish operation. Since 2.24

PENDING: number

Operations are still pending.

PERMISSION_DENIED: number

Permission denied.

PROXY_AUTH_FAILED: number

Proxy authentication failed. Since 2.26

PROXY_FAILED: number

Connection to proxy server failed. Since 2.26

PROXY_NEED_AUTH: number

Proxy server needs authentication. Since 2.26

PROXY_NOT_ALLOWED: number

Proxy connection is not allowed by ruleset. Since 2.26

READ_ONLY: number

File is read only.

TIMED_OUT: number

Operation timed out.

TOO_MANY_LINKS: number

File contains too many symbolic links.

TOO_MANY_OPEN_FILES: number

The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20

WOULD_BLOCK: number

Operation would block.

WOULD_MERGE: number

Operation would merge files.

WOULD_RECURSE: number

Operation would be recursive.

WRONG_ETAG: number

File's Entity Tag was incorrect.

Properties - Inherited from GLib

code: number
domain: number
message: string
stack: string

Methods - Inherited from GLib

  • Returns true if error matches domain and code, false otherwise. In particular, when error is null, false will be returned.

    If domain contains a FAILED (or otherwise generic) error code, you should generally not check for it explicitly, but should instead treat any not-explicitly-recognized error code as being equivalent to the FAILED code. This way, if the domain is extended in the future to provide a more specific error code for a certain case, your code will still work.

    Parameters

    • domain: number | (new (...args: any[]) => GLib.Error)

      an error domain

    • code: number

      an error code

    Returns boolean

    whether error has domain and code

  • This function registers an extended GLib.Error domain. error_type_name will be duplicated. Otherwise does the same as g_error_domain_register_static().

    Parameters

    • error_type_name: string

      string to create a GLib.Quark from

    • error_type_private_size: number

      size of the private error data in bytes

    • error_type_init: ErrorInitFunc

      function initializing fields of the private error data

    • error_type_copy: ErrorCopyFunc

      function copying fields of the private error data

    • error_type_clear: ErrorClearFunc

      function freeing fields of the private error data

    Returns number

  • This function registers an extended GLib.Error domain.

    error_type_name should not be freed. error_type_private_size must be greater than 0.

    error_type_init receives an initialized GLib.Error and should then initialize the private data.

    error_type_copy is a function that receives both original and a copy GLib.Error and should copy the fields of the private error data. The standard GLib.Error fields are already handled.

    error_type_clear receives the pointer to the error, and it should free the fields of the private error data. It should not free the struct itself though.

    Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of passing valid information to this function.

    Parameters

    • error_type_name: string

      static string to create a GLib.Quark from

    • error_type_private_size: number

      size of the private error data in bytes

    • error_type_init: ErrorInitFunc

      function initializing fields of the private error data

    • error_type_copy: ErrorCopyFunc

      function copying fields of the private error data

    • error_type_clear: ErrorClearFunc

      function freeing fields of the private error data

    Returns number