Dex-1 ▶ Dex ▶ Future

constructor

• new Future(): Dex.Future

  Returns Dex.Future

Static$gtype

_init

• _init(...args: any[]): void

  Parameters

  • ...args: any[]

  Returns void

await

• await(): boolean

  Suspends the current Dex.Fiber and resumes when future has completed.

  If future is completed when this function is called, the fiber will handle the result immediately.

  This function may only be called within a Dex.Fiber. To do otherwise will return false and error set to Dex.Error.NO_FIBER.

  It is an error to call this function in a way that would cause intermediate code to become invalid when resuming the stack. For example, if a foreach-style function taking a callback was to suspend from the callback, undefined behavior may occur such as thread-local-storage having changed.

  Returns boolean

  true if the future resolved, otherwise false and error is set.

await_boolean

• await_boolean(): boolean

  Awaits on future and returns the gboolean result.

  If the result is not a gboolean, error is set.

  Returns boolean

  the gboolean, or false and error is set

await_boxed

• await_boxed(): any

  Awaits on future and returns the G_TYPE_BOXED based result.

  Returns any

  the boxed result, or null and error is set.

await_double

• await_double(): number

  Awaits on future and returns the result as an double.

  The resolved value must be of type G_TYPE_INT or error is set.

  Returns number

  an double, or 0 in case of failure and error is set.

await_enum

• await_enum(): number

  Awaits on future and returns the enum result.

  If the result is not a G_TYPE_ENUM, error is set.

  Returns number

  the enum or 0 and error is set.

await_flags

• await_flags(): number

  Awaits on future and returns the flags result.

  If the result is not a G_TYPE_FLAGS, error is set.

  Returns number

  the flags or 0 and error is set.

await_float

• await_float(): number

  Awaits on future and returns the result as an float.

  The resolved value must be of type G_TYPE_INT or error is set.

  Returns number

  an float, or 0 in case of failure and error is set.

await_int

• await_int(): number

  Awaits on future and returns the result as an int.

  The resolved value must be of type G_TYPE_INT or error is set.

  Returns number

  an int, or 0 in case of failure and error is set.

await_int64

• await_int64(): number

  Awaits on future and returns the result as an int64.

  The resolved value must be of type G_TYPE_INT64 or error is set.

  Returns number

  an int64, or 0 in case of failure and error is set.

await_object

• await_object<T = GObject.Object>(): T

  Awaits on future and returns the GObject.Object-based result.

  Type Parameters

  • T = GObject.Object

  Returns T

  the object, or null and error is set.

await_pointer

• await_pointer(): any

  Calls dex_await() and returns the value of g_value_get_pointer(), otherwise error is set if the future rejected.

  Returns any

  a pointer or null

await_string

• await_string(): string

  Awaits on future and returns the string result.

  If the result is not a G_TYPE_STRING, error is set.

  Returns string

  the string or null and error is set

await_uint

• await_uint(): number

  Awaits on future and returns the result as an uint.

  The resolved value must be of type G_TYPE_INT or error is set.

  Returns number

  an uint, or 0 in case of failure and error is set.

await_uint64

• await_uint64(): number

  Awaits on future and returns the result as an uint64.

  The resolved value must be of type G_TYPE_INT64 or error is set.

  Returns number

  an uint64, or 0 in case of failure and error is set.

await_variant

• await_variant(): GLib.Variant

  Awaits on future and returns the G_TYPE_VARIANT based result.

  Returns GLib.Variant

  the variant result, or null and error is set.

Signalconnect

• connect<K extends "notify">(
      signal: K,
      callback: SignalCallback<Dex.Future, Dex.Future.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Dex.Future, Dex.Future.SignalSignatures[K]>

  Returns number

• connect(signal: string, callback: (...args: any[]) => any): number

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

Signalconnect_after

• connect_after<K extends "notify">(
      signal: K,
      callback: SignalCallback<Dex.Future, Dex.Future.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Dex.Future, Dex.Future.SignalSignatures[K]>

  Returns number

• connect_after(signal: string, callback: (...args: any[]) => any): number

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

disown

• disown(): void

  Disowns a future, allowing it to run to completion even though there may be no observer interested in the futures completion or rejection.

  Returns void

Signalemit

• emit<K extends "notify">(
      signal: K,
      ...args: GjsParameters<Dex.Future.SignalSignatures[K]> extends [
          any,
          ...Q[],
      ]
          ? Q
          : never,
  ): void

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • ...args: GjsParameters<Dex.Future.SignalSignatures[K]> extends [any, ...Q[]] ? Q : never

  Returns void

• emit(signal: string, ...args: any[]): void

  Parameters

  • signal: string
  • ...args: any[]

  Returns void

get_name

• get_name(): string

  Returns string

get_status

• get_status(): Dex.FutureStatus

  Returns Dex.FutureStatus

get_value

• get_value(): unknown

  Returns unknown

Staticall

• all(futures: Dex.Future[]): Dex.Future

  Parameters

  • futures: Dex.Future[]

  Returns Dex.Future

Staticall_race

• all_race(futures: Dex.Future[]): Dex.Future

  Parameters

  • futures: Dex.Future[]

  Returns Dex.Future

Staticany

• any(futures: Dex.Future[]): Dex.Future

  Parameters

  • futures: Dex.Future[]

  Returns Dex.Future

Staticcatch

• catch(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future

Staticcatch_loop

• catch_loop(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future

Staticfinally

• finally(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future

Staticfinally_loop

• finally_loop(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future

Staticfirst

• first(futures: Dex.Future[]): Dex.Future

  Parameters

  • futures: Dex.Future[]

  Returns Dex.Future

Staticnew_for_boolean

• new_for_boolean(v_bool: boolean): Dex.Future

  Parameters

  • v_bool: boolean

  Returns Dex.Future

Staticnew_for_double

• new_for_double(v_double: number): Dex.Future

  Parameters

  • v_double: number

  Returns Dex.Future

Staticnew_for_errno

• new_for_errno(errno_: number): Dex.Future

  Parameters

  • errno_: number

  Returns Dex.Future

Staticnew_for_error

• new_for_error(error: GLib.Error): Dex.Future

  Parameters

  • error: GLib.Error

  Returns Dex.Future

Staticnew_for_float

• new_for_float(v_float: number): Dex.Future

  Parameters

  • v_float: number

  Returns Dex.Future

Staticnew_for_int

• new_for_int(v_int: number): Dex.Future

  Parameters

  • v_int: number

  Returns Dex.Future

Staticnew_for_int64

• new_for_int64(v_int64: number): Dex.Future

  Parameters

  • v_int64: number

  Returns Dex.Future

Staticnew_for_object

• new_for_object(value: GObject.Object): Dex.Future

  Parameters

  • value: GObject.Object

  Returns Dex.Future

Staticnew_for_pointer

• new_for_pointer(pointer?: any): Dex.Future

  Parameters

  • Optionalpointer: any

  Returns Dex.Future

Staticnew_for_string

• new_for_string(string: string): Dex.Future

  Parameters

  • string: string

  Returns Dex.Future

Staticnew_for_uint

• new_for_uint(v_uint: number): Dex.Future

  Parameters

  • v_uint: number

  Returns Dex.Future

Staticnew_for_uint64

• new_for_uint64(v_uint64: number): Dex.Future

  Parameters

  • v_uint64: number

  Returns Dex.Future

Staticnew_for_value

• new_for_value(value: any): Dex.Future

  Parameters

  • value: any

  Returns Dex.Future

Staticnew_infinite

• new_infinite(): Dex.Future

  Returns Dex.Future

Staticnew_take_object

• new_take_object(value: GObject.Object): Dex.Future

  Parameters

  • value: GObject.Object

  Returns Dex.Future

Staticnew_take_string

• new_take_string(string: string): Dex.Future

  Parameters

  • string: string

  Returns Dex.Future

Staticthen

• then(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future

Staticthen_loop

• then_loop(future: Dex.Future, callback: FutureCallback): Dex.Future

  Parameters

  • future: Dex.Future
  • callback: FutureCallback

  Returns Dex.Future