promise

Documentation

Index

• func Inspect(typ reflect.Type) (reflect.Type, bool)
• type CanceledError
  • func (e CanceledError) Cause() error
  • func (e CanceledError) Error() string
  • func (e CanceledError) Unwrap() error
• type Deferred
  • func Defer[T any]() Deferred[T]
  • func DeferWithContext[T any](ctx context.Context) Deferred[T]
  • func (d Deferred[T]) Promise() *Promise[T]
  • func (d Deferred[T]) Reject(err error)
  • func (d Deferred[T]) Resolve(resolution T)
• type Promise
  • func All[T any](ctx context.Context, promises ...*Promise[T]) *Promise[[]T]
  • func Catch[T any](p *Promise[T], reject func(err error) error) *Promise[T]
  • func Coerce[T any](promise Reflect) *Promise[T]
  • func Delay[T any](ctx context.Context, delay time.Duration) *Promise[T]
  • func Empty() *Promise[struct{}]
  • func Erase[A any](p *Promise[A]) *Promise[struct{}]
  • func IndirectReturn[A, B any](p *Promise[A], val *B) *Promise[B]
  • func New[T any](ctx context.Context, ...) *Promise[T]
  • func Race[T any](ctx context.Context, promises ...*Promise[T]) *Promise[T]
  • func Reject[T any](err error) *Promise[T]
  • func RejectEmpty(err error) *Promise[struct{}]
  • func Resolve[T any](value T) *Promise[T]
  • func Return[A, B any](p *Promise[A], val B) *Promise[B]
  • func Slice[A any](p *Promise[A]) *Promise[[]A]
  • func Then[A, B any](p *Promise[A], resolve func(A) B) *Promise[B]
  • func Unwrap[T any](promise *Promise[*Promise[T]]) *Promise[T]
  • func (p *Promise[T]) Await() (T, error)
  • func (p *Promise[T]) AwaitAny() (any, error)
  • func (p *Promise[T]) Cancel()
  • func (p *Promise[T]) Catch(rej func(err error) error) *Promise[any]
  • func (p *Promise[T]) Context() context.Context
  • func (p *Promise[T]) OnCancel(fun func()) *Promise[T]
  • func (p *Promise[T]) Then(res func(data any) any) *Promise[any]
  • func (p *Promise[T]) UnderlyingType() reflect.Type
• type Reflect
  • func CoerceType(typ reflect.Type, promise Reflect) Reflect
  • func Lift(typ reflect.Type, result any) Reflect

Functions

func Inspect

func Inspect(typ reflect.Type) (reflect.Type, bool)

Types

type CanceledError

type CanceledError struct {
	// contains filtered or unexported fields
}

func (CanceledError) Cause

func (e CanceledError) Cause() error

func (CanceledError) Error

func (e CanceledError) Error() string

func (CanceledError) Unwrap

func (e CanceledError) Unwrap() error

type Deferred

type Deferred[T any] struct {
	// contains filtered or unexported fields
}

Deferred represents a computation that fulfills a Promise.

func Defer

func Defer[T any]() Deferred[T]

Defer creates a Deferred computation.

func DeferWithContext

func DeferWithContext[T any](ctx context.Context) Deferred[T]

DeferWithContext creates a Deferred computation in a context.

func (Deferred[T]) Promise

func (d Deferred[T]) Promise() *Promise[T]

func (Deferred[T]) Reject

func (d Deferred[T]) Reject(err error)

func (Deferred[T]) Resolve

func (d Deferred[T]) Resolve(resolution T)

type Promise

type Promise[T any] struct {
	// contains filtered or unexported fields
}

Promise represents the eventual completion (or failure) of an asynchronous operation and its resulting value

func All

func All[T any](
	ctx context.Context,
	promises ...*Promise[T],
) *Promise[[]T]

All resolves when all promises have resolved, or rejects immediately upon any of the promises rejecting

func Catch

func Catch[T any](p *Promise[T], reject func(err error) error) *Promise[T]

func Coerce

func Coerce[T any](
	promise Reflect,
) *Promise[T]

func Delay

func Delay[T any](
	ctx context.Context,
	delay time.Duration,
) *Promise[T]

func Empty

func Empty() *Promise[struct{}]

func Erase

func Erase[A any](p *Promise[A]) *Promise[struct{}]

func IndirectReturn

func IndirectReturn[A, B any](p *Promise[A], val *B) *Promise[B]

func New

func New[T any](
	ctx context.Context,
	executor func(resolve func(T), reject func(error), onCancel func(func())),
) *Promise[T]

func Race

func Race[T any](
	ctx context.Context,
	promises ...*Promise[T],
) *Promise[T]

Race resolves or rejects as soon as any one of the promises resolves or rejects

func Reject

func Reject[T any](err error) *Promise[T]

Reject creates a Promise in the rejected state.

func RejectEmpty

func RejectEmpty(err error) *Promise[struct{}]

func Resolve

func Resolve[T any](value T) *Promise[T]

Resolve creates a Promise in the resolved state.

func Return

func Return[A, B any](p *Promise[A], val B) *Promise[B]

func Slice

func Slice[A any](p *Promise[A]) *Promise[[]A]

func Then

func Then[A, B any](p *Promise[A], resolve func(A) B) *Promise[B]

func Unwrap

func Unwrap[T any](
	promise *Promise[*Promise[T]],
) *Promise[T]

func (*Promise[T]) Await

func (p *Promise[T]) Await() (T, error)

func (*Promise[T]) AwaitAny

func (p *Promise[T]) AwaitAny() (any, error)

func (*Promise[T]) Cancel

func (p *Promise[T]) Cancel()

func (*Promise[T]) Catch

func (p *Promise[T]) Catch(
	rej func(err error) error,
) *Promise[any]

func (*Promise[T]) Context

func (p *Promise[T]) Context() context.Context

func (*Promise[T]) OnCancel

func (p *Promise[T]) OnCancel(fun func()) *Promise[T]

func (*Promise[T]) Then

func (p *Promise[T]) Then(
	res func(data any) any,
) *Promise[any]

func (*Promise[T]) UnderlyingType

func (p *Promise[T]) UnderlyingType() reflect.Type

type Reflect

type Reflect interface {
	Context() context.Context
	UnderlyingType() reflect.Type
	Then(resolve func(data any) any) *Promise[any]
	Catch(reject func(err error) error) *Promise[any]
	AwaitAny() (any, error)
}

func CoerceType

func CoerceType(
	typ reflect.Type,
	promise Reflect,
) Reflect

func Lift

func Lift(typ reflect.Type, result any) Reflect