godat

README

godat - Simple data serializer for Go 1.7+

Install

go get github.com/lokhman/godat

Usage

import "github.com/lokhman/godat"

func main() {
    var anyData = ...
    var unserializedData ...

    serializedBytes, err := godat.Marshal(anyData)
    if err != nil {
        panic(err)
    }
    
    err = godat.Unmarshal(serializedBytes, &unserializedData)
    if err != nil {
        panic(err)
    }
    
    // anyData == unserializedData
}

Tests

Use go test for testing.

License

Library is available under the MIT license. The included LICENSE file describes this in detail.

Documentation

Index

• func Dump(filename string, v interface{}, vv ...interface{}) error
• func Load(filename string, v interface{}, vv ...interface{}) error
• func Marshal(v interface{}, vv ...interface{}) ([]byte, error)
• func Unmarshal(data []byte, v interface{}, vv ...interface{}) error
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v interface{}) error
  • func (d *Decoder) DecodeValue(v reflect.Value) error
• type DecoderError
  • func (e DecoderError) Error() string
• type DecoderTypeError
  • func (e DecoderTypeError) Error() string
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(v interface{}) error
  • func (e *Encoder) EncodeValue(v reflect.Value) error
• type EncoderError
  • func (e EncoderError) Error() string

Functions

func Dump

func Dump(filename string, v interface{}, vv ...interface{}) error

func Load

func Load(filename string, v interface{}, vv ...interface{}) error

func Marshal

func Marshal(v interface{}, vv ...interface{}) ([]byte, error)

func Unmarshal

func Unmarshal(data []byte, v interface{}, vv ...interface{}) error

Types

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

func (*Decoder) Decode

func (d *Decoder) Decode(v interface{}) error

func (*Decoder) DecodeValue

func (d *Decoder) DecodeValue(v reflect.Value) error

type DecoderError

type DecoderError struct {
	ErrorString string
}

func (DecoderError) Error

func (e DecoderError) Error() string

type DecoderTypeError

type DecoderTypeError struct {
	Value string
	Type  reflect.Type
}

func (DecoderTypeError) Error

func (e DecoderTypeError) Error() string

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

func (*Encoder) Encode

func (e *Encoder) Encode(v interface{}) error

func (*Encoder) EncodeValue

func (e *Encoder) EncodeValue(v reflect.Value) error

type EncoderError

type EncoderError struct {
	ErrorString string
}

func (EncoderError) Error

func (e EncoderError) Error() string