futures

Documentation

Index

• func WrapResultFunc[R any](fn func() (R, error)) func() Result[R]
• type Future
• type GoFuture
  • func GoResult[R any](fn func() (R, error)) *GoFuture[Result[R]]
  • func (future *GoFuture[R]) Await() R
• type NoopScheduler
  • func NewNoopScheduler[R any]() NoopScheduler[R]
  • func (NoopScheduler[R]) Schedule(executable func() R) Future[R]
• type PoolScheduler
  • func NewWorkerPoolScheduler[R any](config PoolSchedulerConfig) *PoolScheduler[R]
  • func ProvidePoolScheduler[R any](config PoolSchedulerConfig) (*PoolScheduler[R], func())
  • func (scheduler *PoolScheduler[R]) Schedule(executable func() R) Future[R]
• type PoolSchedulerConfig
• type Resolved
  • func NewResolved[R any](value R) *Resolved[R]
  • func (future *Resolved[R]) Await() R
• type Result
  • func FailureResult[R any](err error) Result[R]
  • func NewResult[R any](value R, err error) Result[R]
  • func SuccessResult[R any](value R) Result[R]
  • func WrapResult[R any](value R, err error) Result[R]
  • func (result Result[R]) Get() (R, error)
• type Scheduled
  • func (future *Scheduled[R]) Await() R
• type Scheduler

Functions

func WrapResultFunc

func WrapResultFunc[R any](fn func() (R, error)) func() Result[R]

WrapResultFunc wrap function to return Result.

Types

type Future

type Future[R any] interface {
	Await() R
}

Future interface.

type GoFuture

type GoFuture[R any] struct {
	// contains filtered or unexported fields
}

GoFuture for futures executed in goroutine.

func GoResult

func GoResult[R any](fn func() (R, error)) *GoFuture[Result[R]]

GoResult for futures executed in goroutine.

func (*GoFuture[R]) Await

func (future *GoFuture[R]) Await() R

Await implements Future interface.

type NoopScheduler

type NoopScheduler[R any] struct{}

NoopScheduler execute scheduled task in-place.

func NewNoopScheduler

func NewNoopScheduler[R any]() NoopScheduler[R]

NewNoopScheduler constructor.

func (NoopScheduler[R]) Schedule

func (NoopScheduler[R]) Schedule(
	executable func() R,
) Future[R]

Schedule tasks.

type PoolScheduler

type PoolScheduler[R any] struct {
	// contains filtered or unexported fields
}

PoolScheduler for futures.

func NewWorkerPoolScheduler

func NewWorkerPoolScheduler[R any](
	config PoolSchedulerConfig,
) *PoolScheduler[R]

NewWorkerPoolScheduler constructor.

func ProvidePoolScheduler

func ProvidePoolScheduler[R any](
	config PoolSchedulerConfig,
) (*PoolScheduler[R], func())

ProvidePoolScheduler provider.

func (*PoolScheduler[R]) Schedule

func (scheduler *PoolScheduler[R]) Schedule(
	executable func() R,
) Future[R]

Schedule task. Implements Scheduler interface.

type PoolSchedulerConfig

type PoolSchedulerConfig struct {
	Workers int
}

PoolSchedulerConfig for PoolScheduler.

type Resolved

type Resolved[R any] struct {
	// contains filtered or unexported fields
}

Resolved future.

func NewResolved

func NewResolved[R any](value R) *Resolved[R]

NewResolved constructor.

func (*Resolved[R]) Await

func (future *Resolved[R]) Await() R

Await implements Future interface.

type Result

type Result[R any] struct {
	// contains filtered or unexported fields
}

Result container.

func FailureResult

func FailureResult[R any](err error) Result[R]

FailureResult constructor.

func NewResult

func NewResult[R any](value R, err error) Result[R]

NewResult constructor.

func SuccessResult

func SuccessResult[R any](value R) Result[R]

SuccessResult constructor.

func WrapResult

func WrapResult[R any](value R, err error) Result[R]

WrapResult wrap value and error.

func (Result[R]) Get

func (result Result[R]) Get() (R, error)

Get result value and error.

type Scheduled

type Scheduled[R any] struct {
	// contains filtered or unexported fields
}

Scheduled future.

func (*Scheduled[R]) Await

func (future *Scheduled[R]) Await() R

Await implements Future interface.

type Scheduler

type Scheduler[R any] interface {
	Schedule(func() R) Future[R]
}

Scheduler interface.