stream

Documentation

Index

• Constants
• Variables
• type Compressor
  • func NewCompressor(input, output *bytes.Buffer, header, footer []byte, separator []byte) (*Compressor, error)
  • func (c *Compressor) AddItem(data []byte) error
  • func (c *Compressor) Close() ([]byte, error)
• type JSONPayloadBuilder
  • func NewJSONPayloadBuilder(shareAndLockBuffers bool) *JSONPayloadBuilder
  • func (b *JSONPayloadBuilder) BuildWithOnErrItemTooBigPolicy(marshaler.StreamJSONMarshaler, OnErrItemTooBigPolicy) (forwarder.Payloads, error)
• type OnErrItemTooBigPolicy

Constants

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

Variables

var (
	// ErrPayloadFull is returned when the payload buffer is full
	ErrPayloadFull = errors.New("reached maximum payload size")

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

Types

type Compressor

type Compressor struct{}

Compressor is not implemented

func NewCompressor

func NewCompressor(input, output *bytes.Buffer, header, footer []byte, separator []byte) (*Compressor, error)

NewCompressor not implemented

func (*Compressor) AddItem

func (c *Compressor) AddItem(data []byte) error

AddItem not implemented

func (*Compressor) Close

func (c *Compressor) Close() ([]byte, error)

Close not implemented

type JSONPayloadBuilder

type JSONPayloadBuilder struct {
}

JSONPayloadBuilder is not implemented when zlib is not available.

func NewJSONPayloadBuilder

func NewJSONPayloadBuilder(shareAndLockBuffers bool) *JSONPayloadBuilder

NewJSONPayloadBuilder is not implemented when zlib is not available.

func (*JSONPayloadBuilder) BuildWithOnErrItemTooBigPolicy

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

BuildWithOnErrItemTooBigPolicy is not implemented when zlib is not available.

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
)