jsonstream

Documentation

Index

• Constants
• Variables
• func Payloads(m marshaler.StreamJSONMarshaler) (forwarder.Payloads, error)
• type OnErrItemTooBigPolicy
• type PayloadBuilder
  • func NewPayloadBuilder() *PayloadBuilder
  • func (b *PayloadBuilder) BuildWithOnErrItemTooBigPolicy(marshaler.StreamJSONMarshaler, OnErrItemTooBigPolicy) (forwarder.Payloads, error)

Constants

const (
	// Available is true if the code is compiled in
	Available = false
)

Variables

var (
	// ErrItemTooBig is returned when a item alone exceeds maximum payload size
	ErrItemTooBig = errors.New("item alone exceeds maximum payload size")
)

Functions

func Payloads

func Payloads(m marshaler.StreamJSONMarshaler) (forwarder.Payloads, error)

Payloads serializes a metadata payload and sends it to the forwarder

Types

type OnErrItemTooBigPolicy

type OnErrItemTooBigPolicy int

OnErrItemTooBigPolicy defines the behavior when OnErrItemTooBig occurs.

const (
	// DropItemOnErrItemTooBig when founding an ErrItemTooBig, skips the error and continue
	DropItemOnErrItemTooBig OnErrItemTooBigPolicy = iota

	// FailOnErrItemTooBig when founding an ErrItemTooBig, returns the error and stop
	FailOnErrItemTooBig
)

type PayloadBuilder

type PayloadBuilder struct {
}

PayloadBuilder is not implemented when zlib is not available.

func NewPayloadBuilder

func NewPayloadBuilder() *PayloadBuilder

NewPayloadBuilder is not implemented when zlib is not available.

func (*PayloadBuilder) BuildWithOnErrItemTooBigPolicy

func (b *PayloadBuilder) BuildWithOnErrItemTooBigPolicy(marshaler.StreamJSONMarshaler, OnErrItemTooBigPolicy) (forwarder.Payloads, error)

BuildWithOnErrItemTooBigPolicy is not implemented when zlib is not available.