future

Documentation

Index

• Variables
• func Load(loaders ...LoaderFunc)
• type Future
  • func NewFuture(parent context.Context, resultCh <-chan *Result) *Future
  • func NewFutureError(parent context.Context, err error) *Future
  • func (f *Future) Get() (interface{}, error)
  • func (f *Future) IsDone() bool
• type LoaderFunc
• type Result

Variables

var ErrNoResult = errors.New("no result in future")

ErrNoResult is returned when there was no result

Functions

func Load

func Load(loaders ...LoaderFunc)

Types

type Future

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

Future - a shortcut for waiting on the result channel for a result or error.

func NewFuture

func NewFuture(parent context.Context, resultCh <-chan *Result) *Future

NewFuture - instantiate a new future. The result provider must close resultCh after providing a single result.

func NewFutureError

func NewFutureError(parent context.Context, err error) *Future

NewFutureError instantiate a new future but have it immediately return as an error

func (*Future) Get

func (f *Future) Get() (interface{}, error)

Get - get the result or error. Blocks until the future is done or the context is cancelled.

func (*Future) IsDone

func (f *Future) IsDone() bool

IsDone - is the future done.

type LoaderFunc

type LoaderFunc func()

type Result

type Result struct {
	Value interface{}
	Err   error
}

Result - the result of an async call - either value or error.