jsonstream

Documentation

Index

• func Display(ctx context.Context, in io.Reader, stream Stream, opts ...Options) error
• type JSONError
• type JSONMessage
• type JSONProgress
• type Options
  • func WithAuxCallback(cb func(JSONMessage)) Options
• type Stream

Functions

func Display

func Display(ctx context.Context, in io.Reader, stream Stream, opts ...Options) error

Display prints the JSON messages from the given reader to the given stream.

It wraps the jsonmessage.DisplayJSONMessagesStream function to make it "context aware" and appropriately returns why the function was canceled.

It returns an error if the context is canceled, but not if the input reader / stream is closed.

Types

type JSONError

type JSONError = jsonmessage.JSONError

type JSONMessage

type JSONMessage = jsonmessage.JSONMessage

type JSONProgress

type JSONProgress = jsonmessage.JSONProgress

type Options

type Options func(*options)

func WithAuxCallback

func WithAuxCallback(cb func(JSONMessage)) Options

type Stream

type Stream = jsonmessage.Stream