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

document

package

Go to main page

Versions in this module

v0

v0.2.0

May 24, 2021

Changes in this version

+ func Foobar(d Document) int

v0.1.1

May 24, 2021

v0.1.0

May 24, 2021

Changes in this version

+ const ArrayEnd

+ const ArrayValueDelim

+ var ErrFieldNotFound = errors.New("field not found")

+ var ErrValueNotFound = errors.New("value not found")

+ func ArrayContains(a Array, v Value) (bool, error)

+ func ArrayLength(a Array) (int, error)

+ func Fields(d Document) ([]string, error)

+ func Length(d Document) (int, error)

+ func MapScan(d Document, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func MarshalJSON(d Document) ([]byte, error)

+ func MarshalJSONArray(a Array) ([]byte, error)

+ func Scan(d Document, targets ...interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func ScanDocument(d Document, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func ScanIterator(it Iterator, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func ScanValue(v Value, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func SliceScan(a Array, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ func StructScan(d Document, t interface{}) error — darwin/amd64, linux/amd64, windows/amd64

+ type Array interface

+ GetByIndex func(i int) (Value, error)

+ Iterate func(fn func(i int, value Value) error) error

+ type Document interface

+ GetByField func(field string) (Value, error)

+ Iterate func(fn func(field string, value Value) error) error

+ func NewFromCSV(headers, columns []string) Document

+ func NewFromJSON(data []byte) Document

+ func NewFromMap(m interface{}) (Document, error)

+ func NewFromStruct(s interface{}) (Document, error)

+ type ErrUnsupportedType struct

+ Msg string

+ Value interface{}

+ func (e *ErrUnsupportedType) Error() string

+ type FieldBuffer struct

+ DecodedKey Value

+ EncodedKey []byte

+ func NewFieldBuffer() *FieldBuffer

+ func (fb *FieldBuffer) Add(field string, v Value) *FieldBuffer

+ func (fb *FieldBuffer) Apply(fn func(p Path, v Value) (Value, error)) error

+ func (fb *FieldBuffer) Clone() *FieldBuffer

+ func (fb *FieldBuffer) Copy(d Document) error

+ func (fb *FieldBuffer) Delete(path Path) error

+ func (fb *FieldBuffer) Fields() []string

+ func (fb *FieldBuffer) Key() (Value, error)

+ func (fb *FieldBuffer) MarshalJSON() ([]byte, error)

+ func (fb *FieldBuffer) RawKey() []byte

+ func (fb *FieldBuffer) Replace(field string, v Value) error

+ func (fb *FieldBuffer) Reset()

+ func (fb *FieldBuffer) ScanDocument(d Document) error

+ func (fb *FieldBuffer) Set(path Path, v Value) error

+ func (fb *FieldBuffer) String() string

+ func (fb *FieldBuffer) UnmarshalJSON(data []byte) error

+ func (fb FieldBuffer) GetByField(field string) (Value, error)

+ func (fb FieldBuffer) Iterate(fn func(field string, value Value) error) error

+ func (fb FieldBuffer) Len() int

+ type Iterator interface

+ Iterate func(fn func(d Document) error) error

+ type Keyer interface

+ Key func() (Value, error)

+ RawKey func() []byte

+ type Path []PathFragment

+ func NewPath(fragments ...string) Path

+ func (p Path) Clone() Path

+ func (p Path) GetValueFromArray(a Array) (Value, error)

+ func (p Path) GetValueFromDocument(d Document) (Value, error)

+ func (p Path) IsEqual(other Path) bool

+ func (p Path) String() string

+ type PathFragment struct

+ ArrayIndex int

+ FieldName string

+ type Scanner interface — darwin/amd64, linux/amd64, windows/amd64

+ ScanDocument func(Document) error

+ type Value struct

+ Type ValueType

+ V interface{}

+ func NewArrayValue(a Array) Value

+ func NewBlobValue(x []byte) Value

+ func NewBoolValue(x bool) Value

+ func NewDocumentValue(d Document) Value

+ func NewDoubleValue(x float64) Value

+ func NewIntegerValue(x int64) Value

+ func NewNullValue() Value

+ func NewTextValue(x string) Value

+ func NewValue(x interface{}) (Value, error)

+ func (v Value) Add(u Value) (res Value, err error)

+ func (v Value) Append(buf []byte) ([]byte, error)

+ func (v Value) BitwiseAnd(u Value) (res Value, err error)

+ func (v Value) BitwiseOr(u Value) (res Value, err error)

+ func (v Value) BitwiseXor(u Value) (res Value, err error)

+ func (v Value) CastAs(t ValueType) (Value, error)

+ func (v Value) CastAsArray() (Value, error)

+ func (v Value) CastAsBlob() (Value, error)

+ func (v Value) CastAsBool() (Value, error)

+ func (v Value) CastAsDocument() (Value, error)

+ func (v Value) CastAsDouble() (Value, error)

+ func (v Value) CastAsInteger() (Value, error)

+ func (v Value) CastAsText() (Value, error)

+ func (v Value) Div(u Value) (res Value, err error)

+ func (v Value) IsEqual(other Value) (bool, error)

+ func (v Value) IsGreaterThan(other Value) (bool, error)

+ func (v Value) IsGreaterThanOrEqual(other Value) (bool, error)

+ func (v Value) IsLesserThan(other Value) (bool, error)

+ func (v Value) IsLesserThanOrEqual(other Value) (bool, error)

+ func (v Value) IsNotEqual(other Value) (bool, error)

+ func (v Value) IsTruthy() (bool, error)

+ func (v Value) IsZeroValue() (bool, error)

+ func (v Value) MarshalBinary() ([]byte, error)

+ func (v Value) MarshalJSON() ([]byte, error)

+ func (v Value) Mod(u Value) (res Value, err error)

+ func (v Value) Mul(u Value) (res Value, err error)

+ func (v Value) Scan(t interface{}) error

+ func (v Value) String() string

+ func (v Value) Sub(u Value) (res Value, err error)

+ type ValueBuffer struct

+ Values []Value

+ func NewValueBuffer(values ...Value) *ValueBuffer

+ func SortArray(a Array) (*ValueBuffer, error)

+ func (vb *ValueBuffer) Append(v Value) *ValueBuffer

+ func (vb *ValueBuffer) Apply(fn func(p Path, v Value) (Value, error)) error

+ func (vb *ValueBuffer) Copy(a Array) error

+ func (vb *ValueBuffer) GetByIndex(i int) (Value, error)

+ func (vb *ValueBuffer) IsEqual(other *ValueBuffer) bool

+ func (vb *ValueBuffer) Iterate(fn func(i int, value Value) error) error

+ func (vb *ValueBuffer) Len() int

+ func (vb *ValueBuffer) Replace(index int, v Value) error

+ func (vb *ValueBuffer) ScanArray(a Array) error

+ func (vb *ValueBuffer) Types() []ValueType

+ func (vb *ValueBuffer) UnmarshalJSON(data []byte) error

+ func (vb ValueBuffer) MarshalJSON() ([]byte, error)

+ type ValueEncoder struct

+ func NewValueEncoder(w io.Writer) *ValueEncoder

+ func (ve *ValueEncoder) Encode(v Value) error

+ type ValueType uint8

+ const AnyType

+ const ArrayValue

+ const BlobValue

+ const BoolValue

+ const DocumentValue

+ const DoubleValue

+ const IntegerValue

+ const NullValue

+ const TextValue

+ func (t ValueType) IsAny() bool

+ func (t ValueType) IsNumber() bool

+ func (t ValueType) String() string