jsonarray

Documentation

Overview

Package jsonarray provides JSON-array import and export for the pulse I/O pipeline. The format is a single top-level JSON array of flat objects: [{...}, {...}].

Index

• type Reader
  • func NewReader(fs afero.Fs, path string) *Reader
  • func NewReaderFromBytes(data []byte) *Reader
  • func (r *Reader) Close() error
  • func (r *Reader) ReadHeader() ([]string, error)
  • func (r *Reader) ReadRows(ctx context.Context, fn func(row []string) error) error
  • func (r *Reader) Reset() error
• type Writer
  • func NewWriter(fs afero.Fs, path string) *Writer
  • func NewWriterToBuffer() *Writer
  • func (w *Writer) Bytes() []byte
  • func (w *Writer) Close() error
  • func (w *Writer) WriteHeader(columns []string) error
  • func (w *Writer) WriteRow(values []any) error

Types

type Reader

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

Reader reads a top-level JSON array of objects, one object per row.

func NewReader

func NewReader(fs afero.Fs, path string) *Reader

NewReader creates a Reader from a filesystem path.

func NewReaderFromBytes

func NewReaderFromBytes(data []byte) *Reader

NewReaderFromBytes creates a Reader from raw bytes.

func (*Reader) Close

func (r *Reader) Close() error

Close releases resources.

func (*Reader) ReadHeader

func (r *Reader) ReadHeader() ([]string, error)

ReadHeader returns column names from the first JSON object.

func (*Reader) ReadRows

func (r *Reader) ReadRows(ctx context.Context, fn func(row []string) error) error

ReadRows streams rows to fn. ReadHeader is auto-called if not yet invoked.

func (*Reader) Reset

func (r *Reader) Reset() error

Reset rewinds the reader to the beginning.

type Writer

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

Writer writes a JSON array, one object per row.

func NewWriter

func NewWriter(fs afero.Fs, path string) *Writer

NewWriter creates a Writer targeting a filesystem path.

func NewWriterToBuffer

func NewWriterToBuffer() *Writer

NewWriterToBuffer creates a Writer that accumulates output in an internal buffer.

func (*Writer) Bytes

func (w *Writer) Bytes() []byte

Bytes returns the buffered JSON output. Callers should call Close first.

func (*Writer) Close

func (w *Writer) Close() error

Close emits the closing ']' and flushes to the target path if configured.

func (*Writer) WriteHeader

func (w *Writer) WriteHeader(columns []string) error

WriteHeader stores the column names and emits the opening '['.

func (*Writer) WriteRow

func (w *Writer) WriteRow(values []any) error

WriteRow writes a single object element.