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

• Constants
• func DecodeBase62(value string) ([]byte, error)
• func EncodeBase62(value []byte) string
• func LoadAndUnmarshal(path string, unmarshal func([]byte) error) error
• func LoadAndUnmarshalProtobuf(path string, message proto.Message) error
• func LoadAndUnmarshalTOML(path string, value interface{}) error
• func LoadAndUnmarshalYAML(path string, value interface{}) error
• func MarshalAndSave(path string, marshal func() ([]byte, error)) 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

Constants

const (
	// Base62Alphabet is the alphabet used for Base62 encoding.
	Base62Alphabet = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
)

Functions

func DecodeBase62

func DecodeBase62(value string) ([]byte, error)

DecodeBase62 performs Base62 decoding.

func EncodeBase62

func EncodeBase62(value []byte) string

EncodeBase62 performs Base62 encoding.

func LoadAndUnmarshal

func LoadAndUnmarshal(path string, unmarshal func([]byte) error) error

LoadAndUnmarshal provides the underlying loading and unmarshaling functionality for the encoding package. It reads the data at the specified path and then invokes the specified unmarshaling callback (usually a closure) to decode the data.

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 LoadAndUnmarshalYAML

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

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

func MarshalAndSave

func MarshalAndSave(path string, marshal func() ([]byte, error)) error

MarshalAndSave provide the underlying marshaling and saving functionality for the encoding package. It invokes the specified marshaling callback (usually a closure) and writes the result atomically to the specified path. The data is saved with read/write permissions for the user only.

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
}

ProtobufDecoder is a stream decoder for Protocol Buffers messages. For performance reasons, this type wraps the underlying stream in a buffering reader, which means that the decoder should persist for the lifetime of the stream (since there's no way to know how much data has been read from the stream).

func NewProtobufDecoder

func NewProtobufDecoder(reader io.Reader) *ProtobufDecoder

NewProtobufDecoder creates a new Protocol Buffers stream decoder.

func (*ProtobufDecoder) Decode

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

Decode 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

Encode 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.