Soup-3.0 ▶ Soup ▶ WebsocketError

code

domain

message

stack

copy

• copy(): GLib.Error

  Makes a copy of error.

  Returns GLib.Error

  a new GLib.Error

free

• free(): void

  Frees a GLib.Error and associated resources.

  Returns void

matches

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

  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

Staticdomain_register

• domain_register(
      error_type_name: string,
      error_type_private_size: number,
      error_type_init: ErrorInitFunc,
      error_type_copy: ErrorCopyFunc,
      error_type_clear: ErrorClearFunc,
  ): number

  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

Staticdomain_register_static

• domain_register_static(
      error_type_name: string,
      error_type_private_size: number,
      error_type_init: ErrorInitFunc,
      error_type_copy: ErrorCopyFunc,
      error_type_clear: ErrorClearFunc,
  ): 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

Staticnew_literal

• new_literal(
      domain: number | (new (...args: any[]) => GLib.Error),
      code: number,
      message: string,
  ): GLib.Error

  Parameters

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

  Returns GLib.Error