Class (GI Struct)

GLib-2.0GLibFileError

Values corresponding to errno codes returned from file operations on UNIX. Unlike errno codes, GFileError values are available on all systems, even Windows. The exact meaning of each code depends on what sort of file operation you were performing; the UNIX documentation gives more details. The following error code descriptions come from the GNU C Library manual, and are under the copyright of that manual.

It's not very portable to make detailed assumptions about exactly which errors will be returned from a given operation. Some errors don't occur on some systems, etc., sometimes there are subtle differences in when a system will report a given error, etc.

Hierarchy (View Summary)

Index

Constructors

Properties

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

Permission denied; the file permissions do not allow the attempted operation.

AGAIN: number

Resource temporarily unavailable; the call might work if you try again later.

BADF: number

Bad file descriptor; for example, I/O on a descriptor that has been closed or reading from a descriptor open only for writing (or vice versa).

EXIST: number

Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation.

FAILED: number

Does not correspond to a UNIX error code; this is the standard "failed for unspecified reason" error code present in all GLib.Error error code enumerations. Returned if no specific code applies.

FAULT: number

You passed in a pointer to bad memory. (GLib won't reliably return this, don't pass in pointers to bad memory.)

INTR: number

Interrupted function call; an asynchronous signal occurred and prevented completion of the call. When this happens, you should try the call again.

INVAL: number

Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function.

IO: number

Input/output error; usually used for physical read or write errors. i.e. the disk or other physical device hardware is returning errors.

ISDIR: number

File is a directory; you cannot open a directory for writing, or create or remove hard links to it.

LOOP: number

Too many levels of symbolic links were encountered in looking up a file name. This often indicates a cycle of symbolic links.

MFILE: number

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

NAMETOOLONG: number

Filename too long.

NFILE: number

There are too many distinct file openings in the entire system.

NODEV: number

The underlying file system of the specified file does not support memory mapping.

NOENT: number

No such file or directory. This is a "file doesn't exist" error for ordinary files that are referenced in contexts where they are expected to already exist.

NOMEM: number

No memory available. The system cannot allocate more virtual memory because its capacity is full.

NOSPC: number

No space left on device; write operation on a file failed because the disk is full.

NOSYS: number

Function not implemented; this indicates that the system is missing some functionality.

NOTDIR: number

A file that isn't a directory was specified when a directory is required.

NXIO: number

No such device or address. The system tried to use the device represented by a file you specified, and it couldn't find the device. This can mean that the device file was installed incorrectly, or that the physical device is missing or not correctly attached to the computer.

PERM: number

Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation.

PIPE: number

Broken pipe; there is no process reading from the other end of a pipe. Every library function that returns this error code also generates a 'SIGPIPE' signal; this signal terminates the program if not handled or blocked. Thus, your program will never actually see this code unless it has handled or blocked 'SIGPIPE'.

ROFS: number

The directory containing the new link can't be modified because it's on a read-only file system.

TXTBSY: number

Text file busy.

Properties - Inherited from GLib.Error

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

Methods - Inherited from GLib.Error

  • 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