jsonarray

README

jsonarray

Streaming for JSON Arrays

Documentation

Overview

Package jsonarray provides an interface to stream an array of JSON objects to an io.Writer. This is useful for streaming long JSON arrays to an HTTP response.

Index

• type Encoder
  • func NewEncoder[T any](w io.Writer, hotPipe bool) *Encoder[T]
  • func (ae *Encoder[T]) Encode(v T) error
  • func (ae *Encoder[T]) Finish() error
  • func (ae *Encoder[T]) Reset()
  • func (ae *Encoder[T]) SetIndent(prefix, indent string)

Types

type Encoder

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

func NewEncoder

func NewEncoder[T any](w io.Writer, hotPipe bool) *Encoder[T]

func (*Encoder[T]) Encode

func (ae *Encoder[T]) Encode(v T) error

Encode writes a JSON object to the underlying io.Writer. If the ArrayEncoder was created with hotPipe set to true, it will also flush the writer after writing the object. It is assumed that writing is being done in a single goroutine. If there's a chance of concurrent writes, lock the function invocation with a mutex.

func (*Encoder[T]) Finish

func (ae *Encoder[T]) Finish() error

func (*Encoder[T]) Reset

func (ae *Encoder[T]) Reset()

func (*Encoder[T]) SetIndent

func (ae *Encoder[T]) SetIndent(prefix, indent string)