eventual

Documentation

Overview

Package eventual provides values that eventually have a value.

Index

• Constants
• type Getter
  • func DefaultGetter(val interface{}) Getter
• type Value
  • func NewValue() Value

Constants

const (
	FALSE = 0
	TRUE  = 1
)

Types

type Getter

type Getter func(time.Duration) (interface{}, bool)

Getter is a functional interface for the Value.Get function

func DefaultGetter

func DefaultGetter(val interface{}) Getter

DefaultGetter builds a Getter that always returns the supplied value.

type Value

type Value interface {
	// Set sets this Value to the given val.
	Set(val interface{})

	// Get gets the value, blocks until timeout for a value to become available if
	// one isn't immediately available.
	Get(timeout time.Duration) (interface{}, bool)
}

Value is an eventual value, meaning that callers wishing to access the value block until the value is available.

func NewValue

func NewValue() Value

NewValue creates a new Value.