encoding

Documentation

Overview

Package encoding provides safe, atomic utility methods for encoding/saving to disk and loading from disk/decoding of data in common formats.

Index

• func LoadAndUnmarshalProtobuf(path string, message proto.Message) error
• func LoadAndUnmarshalTOML(path string, value interface{}) error
• func MarshalAndSaveProtobuf(path string, message proto.Message) error
• type ProtobufDecoder
  • func NewProtobufDecoder(reader io.Reader) *ProtobufDecoder
  • func (d *ProtobufDecoder) Decode(message proto.Message) error
• type ProtobufEncoder
  • func NewProtobufEncoder(writer io.Writer) *ProtobufEncoder
  • func (e *ProtobufEncoder) Encode(message proto.Message) error
  • func (e *ProtobufEncoder) EncodeWithoutFlush(message proto.Message) error
  • func (e *ProtobufEncoder) Flush() error

Functions

func LoadAndUnmarshalProtobuf

func LoadAndUnmarshalProtobuf(path string, message proto.Message) error

LoadAndUnmarshalProtobuf loads data from the specified path and decodes it into the specified Protocol Buffers message.

func LoadAndUnmarshalTOML

func LoadAndUnmarshalTOML(path string, value interface{}) error

LoadAndUnmarshalTOML loads data from the specified path and decodes it into the specified structure.

func MarshalAndSaveProtobuf

func MarshalAndSaveProtobuf(path string, message proto.Message) error

MarshalAndSaveProtobuf marshals the specified Protocol Buffers message and saves it to the specified path.

Types

type ProtobufDecoder

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

ProtobufEncoder is a stream decoder for Protocol Buffers messages.

func NewProtobufDecoder

func NewProtobufDecoder(reader io.Reader) *ProtobufDecoder

NewProtobufEncoder creates a new Protocol Buffers stream decoder.

func (*ProtobufDecoder) Decode

func (d *ProtobufDecoder) Decode(message proto.Message) error

Encode decodes a length-prefixed Protocol Buffers message from the underlying stream.

type ProtobufEncoder

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

ProtobufEncoder is a stream encoder for Protocol Buffers messages.

func NewProtobufEncoder

func NewProtobufEncoder(writer io.Writer) *ProtobufEncoder

NewProtobufEncoder creates a new Protocol Buffers stream encoder.

func (*ProtobufEncoder) Encode

func (e *ProtobufEncoder) Encode(message proto.Message) error

EncodeWithoutFlush encodes a length-prefixed Protocol Buffers message into the encoder's internal buffer and writes this data to the underlying stream.

func (*ProtobufEncoder) EncodeWithoutFlush

func (e *ProtobufEncoder) EncodeWithoutFlush(message proto.Message) error

EncodeWithoutFlush encodes a length-prefixed Protocol Buffers message into the encoder's internal buffer, but does not write this data to the underlying stream.

func (*ProtobufEncoder) Flush

func (e *ProtobufEncoder) Flush() error

Flush writes the contents of the encoder's internal buffer, if any, to the underlying stream.