encoding

Documentation

Overview

YAML and JSON encoding

Index

• Variables
• func ConvertFile(infile, outfile string, dataType interface{}) error
• type Encoder
  • func DefaultJSONEncoder() Encoder
  • func DefaultYAMLEncoder() Encoder
  • func NewEncoder(encoder EncoderType) (Encoder, error)
  • func NewEncoderFromFileExt(filename string) (Encoder, error)
• type EncoderType
  • func EncoderTypeFromExt(filename string) (EncoderType, error)
• type JSONEncoder
  • func (e *JSONEncoder) Marshal(data interface{}) (string, error)
  • func (e *JSONEncoder) MarshalIndent(data interface{}) (string, error)
  • func (e *JSONEncoder) UnMarshal(r io.Reader, result interface{}) error
  • func (e *JSONEncoder) UnMarshalStr(data string, result interface{}) error
• type YAMLEncoder
  • func (e *YAMLEncoder) Marshal(data interface{}) (string, error)
  • func (e *YAMLEncoder) MarshalIndent(data interface{}) (string, error)
  • func (e *YAMLEncoder) UnMarshal(r io.Reader, result interface{}) error
  • func (e *YAMLEncoder) UnMarshalStr(data string, result interface{}) error

Variables

var (
	ErrorInvalidExtension = errors.New("File extension must be [.json | .yml | .yaml]")
)

Functions

func ConvertFile

func ConvertFile(infile, outfile string, dataType interface{}) error

Types

type Encoder

type Encoder interface {
	MarshalIndent(data interface{}) (string, error)

	Marshal(data interface{}) (string, error)

	UnMarshal(r io.Reader, result interface{}) error

	UnMarshalStr(data string, result interface{}) error
}

func DefaultJSONEncoder

func DefaultJSONEncoder() Encoder

func DefaultYAMLEncoder

func DefaultYAMLEncoder() Encoder

func NewEncoder

func NewEncoder(encoder EncoderType) (Encoder, error)

func NewEncoderFromFileExt

func NewEncoderFromFileExt(filename string) (Encoder, error)

type EncoderType

type EncoderType int

const (
	JSON EncoderType = 1 + iota
	YAML
)

func EncoderTypeFromExt

func EncoderTypeFromExt(filename string) (EncoderType, error)

type JSONEncoder

type JSONEncoder struct{}

An encoder that marshal's and unmarshal's Json which implements the Encoder interface

func (*JSONEncoder) Marshal

func (e *JSONEncoder) Marshal(data interface{}) (string, error)

func (*JSONEncoder) MarshalIndent

func (e *JSONEncoder) MarshalIndent(data interface{}) (string, error)

func (*JSONEncoder) UnMarshal

func (e *JSONEncoder) UnMarshal(r io.Reader, result interface{}) error

func (*JSONEncoder) UnMarshalStr

func (e *JSONEncoder) UnMarshalStr(data string, result interface{}) error

type YAMLEncoder

type YAMLEncoder struct{}

An encoder that marshal's and unmarshal's YAML which implements the Encoder interface

func (*YAMLEncoder) Marshal

func (e *YAMLEncoder) Marshal(data interface{}) (string, error)

func (*YAMLEncoder) MarshalIndent

func (e *YAMLEncoder) MarshalIndent(data interface{}) (string, error)

func (*YAMLEncoder) UnMarshal

func (e *YAMLEncoder) UnMarshal(r io.Reader, result interface{}) error

func (*YAMLEncoder) UnMarshalStr

func (e *YAMLEncoder) UnMarshalStr(data string, result interface{}) error