bsonenc

Documentation

Overview

Package bsonenc support encoding and decoding instance by bson.

Index

• Variables
• func Marshal(v interface{}) ([]byte, error)
• func MergeBSONM(a bson.M, b ...bson.M) bson.M
• func NewHintedDoc(h hint.Hint) bson.M
• func Unmarshal(b []byte, v interface{}) error
• type Encoder
  • func NewEncoder() *Encoder
  • func (enc *Encoder) Add(ht hint.Hinter) error
  • func (enc *Encoder) Decode(b []byte) (hint.Hinter, error)
  • func (enc *Encoder) DecodeMap(b []byte) (map[string]hint.Hinter, error)
  • func (enc *Encoder) DecodeSlice(b []byte) ([]hint.Hinter, error)
  • func (enc *Encoder) DecodeWithHint(b []byte, ht hint.Hint) (hint.Hinter, error)
  • func (*Encoder) Hint() hint.Hint
  • func (*Encoder) Marshal(v interface{}) ([]byte, error)
  • func (*Encoder) Unmarshal(b []byte, v interface{}) error
• type HintedHead
• type Unpackable

Variables

var (
	BSONEncoderType = hint.Type("bson-encoder")
	BSONEncoderHint = hint.NewHint(BSONEncoderType, "v0.0.1")
)

Functions

func Marshal

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

func MergeBSONM

func MergeBSONM(a bson.M, b ...bson.M) bson.M

func NewHintedDoc

func NewHintedDoc(h hint.Hint) bson.M

func Unmarshal

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

Types

type Encoder

type Encoder struct {
	*hint.Hintset
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder() *Encoder

func (*Encoder) Add

func (enc *Encoder) Add(ht hint.Hinter) error

func (*Encoder) Decode

func (enc *Encoder) Decode(b []byte) (hint.Hinter, error)

func (*Encoder) DecodeMap

func (enc *Encoder) DecodeMap(b []byte) (map[string]hint.Hinter, error)

func (*Encoder) DecodeSlice

func (enc *Encoder) DecodeSlice(b []byte) ([]hint.Hinter, error)

func (*Encoder) DecodeWithHint

func (enc *Encoder) DecodeWithHint(b []byte, ht hint.Hint) (hint.Hinter, error)

func (*Encoder) Hint

func (*Encoder) Hint() hint.Hint

func (*Encoder) Marshal

func (*Encoder) Marshal(v interface{}) ([]byte, error)

func (*Encoder) Unmarshal

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

type HintedHead

type HintedHead struct {
	H hint.Hint `bson:"_hint"`
}

type Unpackable

type Unpackable interface {
	UnpackBSON([]byte, *Encoder) error
}