toml

Documentation

Overview

Package toml provides an API for TOML serialization. This package wraps the BurntSushi toml package.

• https://github.com/BurntSushi/toml

Index

• Variables
• func Marshal(obj interface{}) ([]byte, error)
• func Unmarshal(b []byte) (interface{}, error)
• func UnmarshalType(b []byte, outputType reflect.Type) (interface{}, error)
• type ErrInvalidKind
  • func (e ErrInvalidKind) Error() string

Variables

var (
	ErrEmptyInput = errors.New("empty input")
	// TOML cannot marshal nil values, because of a design decision.
	// https://github.com/toml-lang/toml/issues/30
	ErrNilObject = errors.New("nil object, toml cannot marshal nil values")
)

var (
	DefaultType = reflect.TypeOf(map[string]interface{}{})
)

Functions

func Marshal

func Marshal(obj interface{}) ([]byte, error)

Marshal formats an object into a slice of bytes of TOML.

func Unmarshal

func Unmarshal(b []byte) (interface{}, error)

Unmarshal parses a slice of bytes into a map[string]interface{} object This package is useful when your program needs to parse data, that you have no a priori awareness of its structure or type. If no input is given, then returns ErrEmptyInput.

func UnmarshalType

func UnmarshalType(b []byte, outputType reflect.Type) (interface{}, error)

UnmarshalType parses a slice of bytes into an object of a given type. If no input is given, then returns ErrEmptyInput.

Types

type ErrInvalidKind

type ErrInvalidKind struct {
	Value    reflect.Type
	Expected []reflect.Kind
}

func (ErrInvalidKind) Error

func (e ErrInvalidKind) Error() string