stream

Documentation

Index

• type Stream
  • func NewStream[T any](response *http.Response, optFns ...func(o *StreamOptions)) *Stream[T]
  • func (s Stream[T]) Close() error
  • func (s Stream[T]) Recv() (*T, error)
• type StreamOptions

Types

type Stream

type Stream[T any] struct {
	// contains filtered or unexported fields
}

Stream is a generic streaming reader for decoding JSON-encoded data from an HTTP response.

func NewStream

func NewStream[T any](response *http.Response, optFns ...func(o *StreamOptions)) *Stream[T]

NewStream creates a new instance of the Stream.

func (Stream[T]) Close

func (s Stream[T]) Close() error

Close closes the underlying stream.

func (Stream[T]) Recv

func (s Stream[T]) Recv() (*T, error)

Recv reads and decodes the next value from the stream.

type StreamOptions

type StreamOptions struct {
	Delimeter []byte
}

StreamOptions contains options for configuring the Stream.