Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

bsoncodec

package

Go to main page

Versions in this module

v0

v0.0.16

Oct 11, 2018

Changes in this version

+ var ErrInvalidJSON = errors.New("invalid JSON input")

+ func MarshalExtJSON(val interface{}, canonical, escapeHTML bool) ([]byte, error)

+ func MarshalExtJSONAppend(dst []byte, val interface{}, canonical, escapeHTML bool) ([]byte, error)

+ func MarshalExtJSONAppendWithRegistry(r *Registry, dst []byte, val interface{}, canonical, escapeHTML bool) ([]byte, error)

+ func MarshalExtJSONWithRegistry(r *Registry, val interface{}, canonical, escapeHTML bool) ([]byte, error)

+ func UnmarshalExtJSON(data []byte, canonical bool, val interface{}) error

+ func UnmarshalExtJSONWithRegistry(r *Registry, data []byte, canonical bool, val interface{}) error

type ValueReader

+ func NewExtJSONValueReader(r io.Reader, canonical bool) ValueReader

v0.0.15

Sep 27, 2018

Changes in this version

+ var ErrEOA = errors.New("end of array")

+ var ErrEOD = errors.New("end of document")

+ var ErrNilType = errors.New("cannot perform an encoder or decoder lookup on <nil>")

+ var ErrNotInterface = errors.New("The provided type is not an interface")

+ func ConstructElement(key string, value interface{}) *bson.Element

+ func ConstructElementErr(key string, value interface{}) (*bson.Element, error)

+ func CopyDocument(dst ValueWriter, src ValueReader) error

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

+ func MarshalAppend(dst []byte, val interface{}) ([]byte, error)

+ func MarshalAppendWithRegistry(r *Registry, dst []byte, val interface{}) ([]byte, error)

+ func MarshalWithRegistry(r *Registry, val interface{}) ([]byte, error)

+ func Unmarshal(data []byte, val interface{}) error

+ func UnmarshalWithRegistry(r *Registry, data []byte, val interface{}) error

+ type ArrayReader interface

+ ReadValue func() (ValueReader, error)

+ type ArrayWriter interface

+ WriteArrayElement func() (ValueWriter, error)

+ WriteArrayEnd func() error

+ type BytesReader interface

+ ReadValueBytes func(dst []byte) (bson.Type, []byte, error)

+ type BytesWriter interface

+ WriteValueBytes func(t bson.Type, b []byte) error

+ type CodecZeroer interface

+ IsTypeZero func(interface{}) bool

+ type Copier struct

+ func NewCopier(r *Registry) Copier

+ func (c Copier) AppendDocumentBytes(dst []byte, src ValueReader) ([]byte, error)

+ func (c Copier) AppendValueBytes(dst []byte, src ValueReader) (bson.Type, []byte, error)

+ func (c Copier) CopyDocument(dst ValueWriter, src ValueReader) error

+ func (c Copier) CopyDocumentFromBytes(dst ValueWriter, src []byte) error

+ func (c Copier) CopyDocumentToBytes(src ValueReader) ([]byte, error)

+ func (c Copier) CopyValue(dst ValueWriter, src ValueReader) error

+ func (c Copier) CopyValueFromBytes(dst ValueWriter, t bson.Type, src []byte) error

+ func (c Copier) CopyValueToBytes(src ValueReader) (bson.Type, []byte, error)

+ type DecodeContext struct

+ Truncate bool

+ type Decoder struct

+ func NewDecoder(r *Registry, vr ValueReader) (*Decoder, error)

+ func (d *Decoder) Decode(val interface{}) error

+ func (d *Decoder) Reset(vr ValueReader) error

+ func (d *Decoder) SetRegistry(r *Registry) error

+ type DefaultValueDecoders struct

+ func (dvd DefaultValueDecoders) ArrayDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) BinaryDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) BooleanDecodeValue(dctx DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ByteSliceDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) CodeWithScopeDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) DBPointerDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) DateTimeDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) Decimal128DecodeValue(dctx DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) DocumentDecodeValue(dctx DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ElementSliceDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) EmptyInterfaceDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) FloatDecodeValue(ec DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) IntDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) JSONNumberDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) MapDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) MaxKeyDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) MinKeyDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) NullDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ObjectIDDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ReaderDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) RegexDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) SliceDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) StringDecodeValue(dctx DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) TimeDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) TimestampDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) URLDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) UintDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) UndefinedDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ValueDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ func (dvd DefaultValueDecoders) ValueUnmarshalerDecodeValue(dc DecodeContext, vr ValueReader, i interface{}) error

+ type DefaultValueEncoders struct

+ func (dve DefaultValueEncoders) ArrayEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) BinaryEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) BooleanEncodeValue(ectx EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ByteSliceEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) CodeWithScopeEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) DBPointerEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) DateTimeEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) Decimal128EncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) DocumentEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ElementSliceEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) EmptyInterfaceEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) FloatEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) IntEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) JSONNumberEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) MapEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) MaxKeyEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) MinKeyEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) NullEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ObjectIDEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ReaderEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) RegexEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) SliceEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) StringEncodeValue(ectx EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) TimeEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) TimestampEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) URLEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) UintEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) UndefinedEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ValueEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ func (dve DefaultValueEncoders) ValueMarshalerEncodeValue(ec EncodeContext, vw ValueWriter, i interface{}) error

+ type DocumentReader interface

+ ReadElement func() (string, ValueReader, error)

+ type DocumentWriter interface

+ WriteDocumentElement func(string) (ValueWriter, error)

+ WriteDocumentEnd func() error

+ type EncodeContext struct

+ MinSize bool

+ type Encoder struct

+ func NewEncoder(r *Registry, vw ValueWriter) (*Encoder, error)

+ func (e *Encoder) Encode(val interface{}) error

+ func (e *Encoder) Reset(vw ValueWriter) error

+ func (e *Encoder) SetRegistry(r *Registry) error

+ type ErrNoDecoder struct

+ Type reflect.Type

+ func (end ErrNoDecoder) Error() string

+ type ErrNoEncoder struct

+ Type reflect.Type

+ func (ene ErrNoEncoder) Error() string

+ type Marshaler interface

+ MarshalBSON func() ([]byte, error)

+ type Registry struct

+ func (r *Registry) LookupDecoder(t reflect.Type) (ValueDecoder, error)

+ func (r *Registry) LookupEncoder(t reflect.Type) (ValueEncoder, error)

+ type RegistryBuilder struct

+ func NewEmptyRegistryBuilder() *RegistryBuilder

+ func NewRegistryBuilder() *RegistryBuilder

+ func (rb *RegistryBuilder) Build() *Registry

+ func (rb *RegistryBuilder) RegisterCodec(t reflect.Type, codec ValueCodec) *RegistryBuilder

+ func (rb *RegistryBuilder) RegisterDecoder(t reflect.Type, dec ValueDecoder) *RegistryBuilder

+ func (rb *RegistryBuilder) RegisterDefaultDecoder(kind reflect.Kind, dec ValueDecoder) *RegistryBuilder

+ func (rb *RegistryBuilder) RegisterDefaultEncoder(kind reflect.Kind, enc ValueEncoder) *RegistryBuilder

+ func (rb *RegistryBuilder) RegisterEncoder(t reflect.Type, enc ValueEncoder) *RegistryBuilder

+ type StructCodec struct

+ func NewStructCodec(p StructTagParser) (*StructCodec, error)

+ func (sc *StructCodec) DecodeValue(r DecodeContext, vr ValueReader, i interface{}) error

+ func (sc *StructCodec) EncodeValue(r EncodeContext, vw ValueWriter, i interface{}) error

+ type StructTagParser interface

+ ParseStructTags func(reflect.StructField) (StructTags, error)

+ type StructTagParserFunc func(reflect.StructField) (StructTags, error)

+ var DefaultStructTagParser StructTagParserFunc = func(sf reflect.StructField) (StructTags, error) { ... }

+ func (stpf StructTagParserFunc) ParseStructTags(sf reflect.StructField) (StructTags, error)

+ type StructTags struct

+ Inline bool

+ MinSize bool

+ Name string

+ OmitEmpty bool

+ Skip bool

+ Truncate bool

+ type TransitionError struct

+ func (te TransitionError) Error() string

+ type Unmarshaler interface

+ UnmarshalBSON func([]byte) error

+ type ValueCodec interface

+ type ValueDecoder interface

+ DecodeValue func(DecodeContext, ValueReader, interface{}) error

+ type ValueDecoderError struct

+ Name string

+ Received interface{}

+ Types []interface{}

+ func (vde ValueDecoderError) Error() string

+ type ValueDecoderFunc func(DecodeContext, ValueReader, interface{}) error

+ func (fn ValueDecoderFunc) DecodeValue(dc DecodeContext, vr ValueReader, val interface{}) error

+ type ValueEncoder interface

+ EncodeValue func(EncodeContext, ValueWriter, interface{}) error

+ type ValueEncoderError struct

+ Name string

+ Received interface{}

+ Types []interface{}

+ func (vee ValueEncoderError) Error() string

+ type ValueEncoderFunc func(EncodeContext, ValueWriter, interface{}) error

+ func (fn ValueEncoderFunc) EncodeValue(ec EncodeContext, vw ValueWriter, val interface{}) error

+ type ValueMarshaler interface

+ MarshalBSONValue func() (bson.Type, []byte, error)

+ type ValueReader interface

+ ReadArray func() (ArrayReader, error)

+ ReadBinary func() (b []byte, btype byte, err error)

+ ReadBoolean func() (bool, error)

+ ReadCodeWithScope func() (code string, dr DocumentReader, err error)

+ ReadDBPointer func() (ns string, oid objectid.ObjectID, err error)

+ ReadDateTime func() (int64, error)

+ ReadDecimal128 func() (decimal.Decimal128, error)

+ ReadDocument func() (DocumentReader, error)

+ ReadDouble func() (float64, error)

+ ReadInt32 func() (int32, error)

+ ReadInt64 func() (int64, error)

+ ReadJavascript func() (code string, err error)

+ ReadMaxKey func() error

+ ReadMinKey func() error

+ ReadNull func() error

+ ReadObjectID func() (objectid.ObjectID, error)

+ ReadRegex func() (pattern, options string, err error)

+ ReadString func() (string, error)

+ ReadSymbol func() (symbol string, err error)

+ ReadTimestamp func() (t, i uint32, err error)

+ ReadUndefined func() error

+ Skip func() error

+ Type func() bson.Type

+ func NewDocumentValueReader(d *bson.Document) (ValueReader, error)

+ func NewValueReader(b []byte) ValueReader

+ type ValueUnmarshaler interface

+ UnmarshalBSONValue func(bson.Type, []byte) error

+ type ValueWriter interface

+ WriteArray func() (ArrayWriter, error)

+ WriteBinary func(b []byte) error

+ WriteBinaryWithSubtype func(b []byte, btype byte) error

+ WriteBoolean func(bool) error

+ WriteCodeWithScope func(code string) (DocumentWriter, error)

+ WriteDBPointer func(ns string, oid objectid.ObjectID) error

+ WriteDateTime func(dt int64) error

+ WriteDecimal128 func(decimal.Decimal128) error

+ WriteDocument func() (DocumentWriter, error)

+ WriteDouble func(float64) error

+ WriteInt32 func(int32) error

+ WriteInt64 func(int64) error

+ WriteJavascript func(code string) error

+ WriteMaxKey func() error

+ WriteMinKey func() error

+ WriteNull func() error

+ WriteObjectID func(objectid.ObjectID) error

+ WriteRegex func(pattern, options string) error

+ WriteString func(string) error

+ WriteSymbol func(symbol string) error

+ WriteTimestamp func(t, i uint32) error

+ WriteUndefined func() error

+ func NewBSONValueWriter(w io.Writer) (ValueWriter, error)

+ func NewDocumentValueWriter(d *bson.Document) (ValueWriter, error)

+ func NewExtJSONValueWriter(w io.Writer) (ValueWriter, error)