protostream

Documentation

Overview

Package protostream implements reading and writing of protobuf messages to data streams.

Index

• type Reader
  • func NewReader(src io.Reader) *Reader
  • func (r *Reader) Read(dst proto.Message) error
  • func (r *Reader) ReadAny() (proto.Message, error)
• type Writer
  • func NewWriter(dest io.Writer) *Writer
  • func (w *Writer) Write(msg proto.Message) error
  • func (w *Writer) WriteAny(msg proto.Message) error

Types

type Reader

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

Reader reads protobuf messages from an io.Reader.

func NewReader

func NewReader(src io.Reader) *Reader

NewReader returns a new Reader. src is the io.Reader that the Reader should read the log from.

func (*Reader) Read

func (r *Reader) Read(dst proto.Message) error

Read reads a protobuf message from the stream and unmarshals it into the dst message.

func (*Reader) ReadAny

func (r *Reader) ReadAny() (proto.Message, error)

ReadAny reads a protobuf message wrapped in an anypb.Any message from the stream.

type Writer

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

Writer writes protobuf messages to an io.Writer.

func NewWriter

func NewWriter(dest io.Writer) *Writer

NewWriter returns a new Writer. dest is the io.Writer that the Writer should write to (the stream).

func (*Writer) Write

func (w *Writer) Write(msg proto.Message) error

Write writes a proto message to the stream.

func (*Writer) WriteAny

func (w *Writer) WriteAny(msg proto.Message) error

WriteAny writes a proto message to the stream wrapped in an anypb.Any message.