codec

Documentation

Overview

Package codec defines a config codec interface.

Index

• Variables
• func Register(name string, codec Codec)
• type Codec
  • func Get(name string) (Codec, error)

Variables

var (
	// ErrCodec is the base error of codec package.
	ErrCodec = errorex.New("codec")
	// ErrCodecNotRegistered is returned by Get if the requested Codec is not
	// registered.
	ErrCodecNotRegistered = ErrCodec.WrapFormat("codec '%s' not registered")
)

Functions

func Register

func Register(name string, codec Codec)

Register registers a Config codec under the specified name. It panics if the name is already registered.

Types

type Codec

type Codec interface {
	// Encode must encode interface to a byte slice or return an error.
	Encode(interface{}) ([]byte, error)
	// Decode must decode the byte slice to the interface or return an error.
	Decode([]byte, interface{}) error
}

Codec defines a configuration marshaling Codec interface.

func Get

func Get(name string) (Codec, error)

Get returns the codec registered under specified name and a nil error, if found. Otherwise a nil filter and an error.