encoding

Documentation

Overview

Package encoding provides interfaces for configuration encoders and decoders.

Additional encoders can be added through the Register function. This allows for separation of concerns internally, but also for plugins to implement their own encoding.

Index

• Variables
• func GetEncodings() []string
• func Register(name string, encoding Encoding)
• type Decoder
• type Encoder
• type Encoding
  • func New(format string) (Encoding, error)

Variables

var (
	// UnknownEncodingError is returned when an unknown encoding is requested using New.
	UnknownEncodingError = errors.New("unknown encoding requested")

	// IllFormattedVariable is returned when a payload contains a line that cannot be resolved to a config.Variable.
	IllFormattedVariable = errors.New("variable is incorrectly formatted")
)

Functions

func GetEncodings

func GetEncodings() []string

Get available Encoding names.

func Register

func Register(name string, encoding Encoding)

Register the given Encoding in a registry for New instances.

Types

type Decoder

type Decoder interface {
	Decode(payload []byte) ([]*config.Variable, error)
}

Allows to Decode a byte sequence into a list of config.Variable structs.

type Encoder

type Encoder interface {
	Encode(variables ...*config.Variable) ([]byte, error)
}

Allows to Encode config.Variable structs into a byte sequence.

type Encoding

type Encoding interface {
	Encoder
	Decoder
}

Shared interface Encoding for Encoder and Decoder.

func New

func New(format string) (Encoding, error)

Create a new Encoding for the given format.