future

README

Future

Documentation

Index

• func New(fn fn.Callable) func() error
• func NewWithContext(ctx context.Context, fn fn.Callable) func() error
• type Callback
• type Factory
  • func NewFactory(opts ...Option) Factory
• type Option
  • func WithContext(ctx context.Context) Option
• type Options

Examples

• New

Functions

func New

func New(fn fn.Callable) func() error

New is a wrapper around Factory with no options provided returning a new future

Example

// define the response globally to be set in the callable
var rsp *http.Response

future := New(func() (err error) {
	rsp, err = http.Get("http://example.com")
	return err
})
// do some stuff here

if err := future(); err != nil {
	// handle error
}
defer rsp.Body.Close()
// use the response

func NewWithContext

func NewWithContext(ctx context.Context, fn fn.Callable) func() error

NewWithContext creates a future func with provided callable and context

Types

type Callback

type Callback func(err error)

Callback is a future callback (can be used to notify the status of the operation)

type Factory

type Factory func(fn fn.Callable) func() error

Factory is a future factory

func NewFactory

func NewFactory(opts ...Option) Factory

NewFactory creates new future factory with provided options

type Option

type Option func(o *Options)

Option applies a single retry option to the strategy config

func WithContext

func WithContext(ctx context.Context) Option

WithContext defines future context

type Options

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

Options is a future config