future: imported from dcos-storage/pkg/future

[jdef]

future

Checklist

• [?] ~80% unit test coverage?
• [x] Updated README.md?
• [x] Completed sections of this PR template?
• [x] Edited all sections [IN BRACKETS]

Overview of Change

future is a utility package that provides helpful functionality on top of a basic Go channel. This package has been incubating in the dcos-storage project and we're upstreaming it now so that other projects can leverage it.

Changelog [optional]

N/A

Affected Usage

N/A

[jdef]

ouch, lots of missing docs. marking this WIP and adding docs now...

/go/src/github.com/dcos/dcos-go/future/future.go:11:6: exported type Interface should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:15:6: exported type Func should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:17:1: exported method Func.Future should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:26:6: exported type Future should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:108:6: exported type Completer should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:112:6: exported type CompleterFunc should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:114:1: exported method CompleterFunc.Complete should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:116:1: exported method CompleterFunc.Apply should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:118:1: exported method CompleterFunc.If should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:127:1: exported function Do should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:131:6: exported type Options should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:137:6: exported type Optional should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:141:6: exported type Option should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:143:1: exported method Option.Apply should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:145:6: exported type Promise should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:198:1: exported function NewPromise should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:354:1: exported function Nil should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:406:6: exported type Merger should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:413:1: exported method MergeFunc.Merge should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:423:1: exported method FirstError.Merge should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/future.go:588:5: exported var ErrFlattenInvalid should have comment or be unexported
/go/src/github.com/dcos/dcos-go/future/must.go:7:1: exported function Must should have comment or be unexported

[jdef]

unrelated dcos-go-windows error:

go: github.com/Sirupsen/[email protected]: parsing go.mod: unexpected module path "github.com/sirupsen/logrus"
go: error loading module requirements
Failed to install github.com/Sirupsen/logrus
at Install-GoDependencies, C:\Users\jenkins\workspace\public-dcos-go-windows\run-go-tests.ps1: line 219
at <ScriptBlock>, C:\Users\jenkins\workspace\public-dcos-go-windows\run-go-tests.ps1: line 462