stream

Documentation

Index

• func Copy(dest io.Writer, src io.Reader) error
• func Create(c context.Context, key string) error
• func Delete(c context.Context, key string) error
• func Reader(c context.Context, key string) (io.ReadCloser, error)
• func ToContext(c Setter, s Stream)
• func ToKey(i int64) string
• func Writer(c context.Context, key string) (io.WriteCloser, error)
• type Setter
• type Stream
  • func FromContext(c context.Context) Stream
  • func New() Stream

Functions

func Copy

func Copy(dest io.Writer, src io.Reader) error

Copy copies the stream from the source to the destination in valid JSON format. This converts the logs, which are per-line JSON objects, to a proper JSON array.

func Create

func Create(c context.Context, key string) error

Create creates a new stream.

func Delete

func Delete(c context.Context, key string) error

Delete deletes the stream by key.

func Reader

func Reader(c context.Context, key string) (io.ReadCloser, error)

Reader opens the stream for reading.

func ToContext

func ToContext(c Setter, s Stream)

ToContext adds the Stream to this context if it supports the Setter interface.

func ToKey

func ToKey(i int64) string

ToKey is a helper function that converts a unique identifier of type int64 into a string.

func Writer

func Writer(c context.Context, key string) (io.WriteCloser, error)

Writer opens the stream for writing.

Types

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.

type Stream

type Stream interface {
	Create(string) error
	Delete(string) error
	Reader(string) (io.ReadCloser, error)
	Writer(string) (io.WriteCloser, error)
}

Stream manages the stream of build logs.

func FromContext

func FromContext(c context.Context) Stream

FromContext returns the Stream associated with this context.

func New

func New() Stream

New returns a new in-memory implementation of Stream.