bson

Documentation

Overview

Package bson provides converters from/to BSON for built-in and `types` types.

See contributing guidelines and documentation for package `types` for details.

Index

• type CString
  • func (cstr CString) MarshalBinary() ([]byte, error)
  • func (cstr *CString) ReadFrom(r *bufio.Reader) error
  • func (cstr CString) WriteTo(w *bufio.Writer) error
• type Document
  • func ConvertDocument(d document) (*Document, error)
  • func MustConvertDocument(d document) *Document
  • func (doc *Document) Keys() []string
  • func (doc *Document) Map() map[string]any
  • func (doc Document) MarshalBinary() ([]byte, error)
  • func (doc *Document) ReadFrom(r *bufio.Reader) error
  • func (doc Document) WriteTo(w *bufio.Writer) error

Types

type CString

type CString string

CString represents BSON zero-terminated UTF-8 string type.

func (CString) MarshalBinary

func (cstr CString) MarshalBinary() ([]byte, error)

MarshalBinary implements bsontype interface.

func (*CString) ReadFrom

func (cstr *CString) ReadFrom(r *bufio.Reader) error

ReadFrom implements bsontype interface.

func (CString) WriteTo

func (cstr CString) WriteTo(w *bufio.Writer) error

WriteTo implements bsontype interface.

type Document

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

Document represents BSON Document type.

func ConvertDocument

func ConvertDocument(d document) (*Document, error)

ConvertDocument converts types.Document to bson.Document and validates it. It references the same data without copying it.

TODO Remove it.

func MustConvertDocument

func MustConvertDocument(d document) *Document

MustConvertDocument is a ConvertDocument that panics in case of error.

func (*Document) Keys

func (doc *Document) Keys() []string

Keys returns the keys associated with the document.

func (*Document) Map

func (doc *Document) Map() map[string]any

Returns the map of key values associated with the Document.

func (Document) MarshalBinary

func (doc Document) MarshalBinary() ([]byte, error)

MarshalBinary implements bsontype interface.

func (*Document) ReadFrom

func (doc *Document) ReadFrom(r *bufio.Reader) error

ReadFrom implements bsontype interface.

func (Document) WriteTo

func (doc Document) WriteTo(w *bufio.Writer) error

WriteTo implements bsontype interface.