stream

Documentation

Overview

Package stream provides utility functions to consume Entry streams.

Index

• func ReadEntries(r io.Reader) <-chan *spb.Entry
• func ReadJSONEntries(r io.Reader) <-chan *spb.Entry
• func StructuredFactValueJSON(e *spb.Entry) (json.RawMessage, error)
• type EntryReader
  • func NewJSONReader(r io.Reader) EntryReader
  • func NewReader(r io.Reader) EntryReader
  • func NewStructuredJSONReader(r io.Reader) EntryReader
• type StructuredEntry
  • func Structured(e *spb.Entry) *StructuredEntry
  • func (r *StructuredEntry) MarshalJSON() ([]byte, error)
  • func (r *StructuredEntry) ProtoMessage()
  • func (r *StructuredEntry) Reset()
  • func (r *StructuredEntry) String() string
  • func (r *StructuredEntry) UnmarshalJSON(data []byte) error

Functions

func ReadEntries

func ReadEntries(r io.Reader) <-chan *spb.Entry

ReadEntries reads a stream of Entry protobufs from r.

func ReadJSONEntries

func ReadJSONEntries(r io.Reader) <-chan *spb.Entry

ReadJSONEntries reads a JSON stream of Entry protobufs from r.

func StructuredFactValueJSON

func StructuredFactValueJSON(e *spb.Entry) (json.RawMessage, error)

StructuredFactValueJSON creates a json object from e.FactValue

Types

type EntryReader

type EntryReader func(func(*spb.Entry) error) error

EntryReader functions read a stream of entries, passing each to a handler function.

func NewJSONReader

func NewJSONReader(r io.Reader) EntryReader

NewJSONReader reads a JSON stream of Entry protobufs from r.

func NewReader

func NewReader(r io.Reader) EntryReader

NewReader reads a stream of Entry protobufs from r.

func NewStructuredJSONReader

func NewStructuredJSONReader(r io.Reader) EntryReader

NewStructuredJSONReader reads a JSON stream of StructuredEntry protobufs from r.

type StructuredEntry

type StructuredEntry spb.Entry

StructuredEntry has custom marshaling behavior to handle structured FactValues

func Structured

func Structured(e *spb.Entry) *StructuredEntry

Structured creates an entry that serializes factValue to a full value

func (*StructuredEntry) MarshalJSON

func (r *StructuredEntry) MarshalJSON() ([]byte, error)

MarshalJSON marshals r including an object representation of FactValue when appropriate

func (*StructuredEntry) ProtoMessage

func (r *StructuredEntry) ProtoMessage()

ProtoMessage calls the implementation for Entry

func (*StructuredEntry) Reset

func (r *StructuredEntry) Reset()

Reset calls the implementation for Entry

func (*StructuredEntry) String

func (r *StructuredEntry) String() string

String calls the implementation for Entry

func (*StructuredEntry) UnmarshalJSON

func (r *StructuredEntry) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals r including an object representation of FactValue when appropriate