codec

Documentation

Overview

Package codec contains sub-packages with different codecs that can be used to encode and decode entities in Storm.

Example

package main

import (
	"fmt"

	"github.com/chikamif/storm"
	"github.com/chikamif/storm/codec/gob"
	"github.com/chikamif/storm/codec/json"
)

func main() {
	// The examples below show how to set up all the codecs shipped with Storm.
	// Proper error handling left out to make it simple.
	var gobDb, _ = storm.Open("gob.db", storm.Codec(gob.Codec))
	var jsonDb, _ = storm.Open("json.db", storm.Codec(json.Codec))
	fmt.Printf("%T\n", gobDb.Codec())
	fmt.Printf("%T\n", jsonDb.Codec())

}

Output:
*gob.gobCodec
*json.jsonCodec

Index

• type MarshalUnmarshaler

Examples

• Package

Types

type MarshalUnmarshaler

type MarshalUnmarshaler interface {
	Marshal(v interface{}) ([]byte, error)
	Unmarshal(b []byte, v interface{}) error
	// name of this codec
	Name() string
}

MarshalUnmarshaler represents a codec used to marshal and unmarshal entities.