context

Documentation

Overview

Package context provides a Context type to propagate state and cancellation information.

Index

• Variables
• type Context
  • func New(params ...Param) *Context
  • func TODO() *Context
  • func (c *Context) Cancel()
  • func (c *Context) Done() <-chan struct{}
  • func (c *Context) HTTPClient() *http.Client
  • func (c *Context) IsCanceled() bool
  • func (c *Context) New(params ...Param) *Context
• type Param
  • func WithHTTPClient(cl *http.Client) Param

Variables

var ErrCanceled = errors.New("canceled")

ErrCanceled may be returned by code when it receives from a Context.Done channel.

Types

type Context

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

A Context is carries state and cancellation information between calls. A nil Context pointer is valid, for now.

func New

func New(params ...Param) *Context

New returns a new Context. Any provided params modify the returned context.

func TODO

func TODO() *Context

TODO returns a dummy context. It's a signal that the caller code is not yet correct, and needs its own context to propagate.

func (*Context) Cancel

func (c *Context) Cancel()

Cancel cancels the context. It is idempotent.

func (*Context) Done

func (c *Context) Done() <-chan struct{}

Done returns a channel that is closed when the Context is canceled or finished.

func (*Context) HTTPClient

func (c *Context) HTTPClient() *http.Client

HTTPClient returns the HTTP Client to use for this context.

func (*Context) IsCanceled

func (c *Context) IsCanceled() bool

IsCanceled reports whether this context has been canceled.

func (*Context) New

func (c *Context) New(params ...Param) *Context

New returns a child context attached to the receiver parent context c. The returned context is done when the parent is done, but the returned child context can be canceled independently without affecting the parent.

type Param

type Param interface {
	// contains filtered or unexported methods
}

A Param modifies a Context as returned by New.

func WithHTTPClient

func WithHTTPClient(cl *http.Client) Param

WithHTTPClient sets the HTTP client as returned by HTTPClient.