document

package

Go to main page

Versions in this module

v0

v0.15.3

Dec 17, 2023

v0.15.2

Jun 18, 2023

v0.15.1

Jul 14, 2022

v0.15.0

Jun 27, 2022

Changes in this version

+ func CloneValue(v types.Value) (types.Value, error)

+ func MapScan(d types.Document, t interface{}) error — js/wasm

+ func MaskFields(d types.Document, fields ...string) types.Document

+ func NewFromCSV(headers, columns []string) types.Document — js/wasm

+ func NewFromJSON(data []byte) types.Document — js/wasm

+ func NewFromMap(m map[string]T) types.Document — js/wasm

+ func NewFromStruct(s interface{}) (types.Document, error) — js/wasm

+ func OnlyFields(d types.Document, fields ...string) types.Document

+ func Scan(d types.Document, targets ...interface{}) error — js/wasm

+ func ScanDocument(d types.Document, t interface{}) error — js/wasm

+ func ScanField(d types.Document, field string, dest interface{}) error

+ func ScanIterator(it Iterator, t interface{}) error — js/wasm

+ func ScanPath(d types.Document, path Path, dest interface{}) error

+ func ScanValue(v types.Value, t interface{}) error — js/wasm

+ func SliceScan(a types.Array, t interface{}) error — js/wasm

+ func StructScan(d types.Document, t interface{}) error — js/wasm

+ func WithSortedFields(d types.Document) types.Document

+ type Op struct

+ Path Path

+ Type string

+ Value types.Value

+ func Diff(d1, d2 types.Document) ([]Op, error)

+ func NewDeleteOp(path Path, v types.Value) Op

+ func NewSetOp(path Path, v types.Value) Op

+ func (o *Op) MarshalBinary() ([]byte, error)

type Path

+ func (p Path) Extend(f ...PathFragment) Path

+ func (p Path) ExtendField(field string) Path

+ func (p Path) ExtendIndex(index int) Path

+ type Scanner interface — js/wasm

+ ScanDocument func(types.Document) error

v0.14.1

Dec 22, 2021

v0.14.0

Dec 6, 2021

Changes in this version

+ type Paths []Path

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

+ func (p Paths) String() string

v0.13.0

Jul 21, 2021

Changes in this version

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

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

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

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

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

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

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

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

+ func NewFromCSV(headers, columns []string) types.Document — darwin/amd64, linux/amd64, windows/amd64

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

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

+ func ValueToJSON(v types.Value) ([]byte, error)

+ func ValueToString(v types.Value) string

+ type JsonArray struct

+ func (j JsonArray) MarshalJSON() ([]byte, error)

+ type JsonDocument struct

+ func (j JsonDocument) MarshalJSON() ([]byte, error)

v0.12.0

May 1, 2021

Changes in this version

+ const ArrayEnd

+ const ArrayValueDelim

type FieldBuffer

+ func (fb *FieldBuffer) String() string

type Path

+ func (p Path) Clone() Path

type ValueBuffer

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

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

type ValueType

+ const AnyType

+ func (t ValueType) IsAny() bool

v0.11.0

Mar 16, 2021

Changes in this version

type ValueBuffer

+ Values []Value

v0.10.1

Jan 28, 2021

v0.10.0

Jan 26, 2021

Changes in this version

type AggregatorBuilder

+ Aggregator func(group Value) Aggregator

type FieldBuffer

+ DecodedKey Value

+ EncodedKey []byte

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

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

type Keyer

+ RawKey func() []byte

type Path

+ func NewPath(fragments ...string) Path

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

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

type ValueBuffer

+ func (vb *ValueBuffer) Len() int

type ValueType

+ func (t ValueType) IsZero() bool

v0.9.0

Nov 12, 2020

Changes in this version

type FieldBuffer

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

+ type Path []PathFragment

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

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

+ func (p Path) String() string

+ type PathFragment struct

+ ArrayIndex int

+ FieldName string

type Value

+ func (v *Value) UnmarshalBinary(data []byte) error

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

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

type ValueBuffer

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

+ type ValueEncoder struct

+ func NewValueEncoder(w io.Writer) *ValueEncoder

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

v0.8.1

Oct 30, 2020

v0.8.0

Sep 26, 2020

Changes in this version

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

+ func IteratorToJSON(w io.Writer, s Iterator) error — js/wasm

+ func IteratorToJSONArray(w io.Writer, s Iterator) error — js/wasm

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

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

+ type Aggregator interface

+ Add func(d Document) error

+ Aggregate func(fb *FieldBuffer) error

+ type AggregatorBuilder interface

+ NewAggregator func(group Value) Aggregator

type FieldBuffer — js/wasm

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

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

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

+ type IteratorFunc func(func(d Document) error) error

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

type Stream

+ func (s Stream) Aggregate(aggregatorBuilders ...AggregatorBuilder) Stream

+ func (s Stream) GroupBy(groupFn func(d Document) (Value, error)) Stream

type Value — js/wasm

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

+ func (v Value) String() string

type ValueBuffer — js/wasm

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

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

type ValuePath

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

v0.7.1

Sep 1, 2020

v0.7.0

Aug 25, 2020

Changes in this version

type Value

+ func NewDoubleValue(x float64) Value

+ func NewIntegerValue(x int64) Value

+ 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) CastAsDuration() (Value, error)

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

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

+ type ValuePathFragment struct

+ ArrayIndex int

+ FieldName string

type ValueType

+ const DoubleValue

+ const IntegerValue

v0.6.0

Jun 28, 2020

Changes in this version

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

+ var ErrStreamClosed = errors.New("stream closed")

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

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

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

+ func ArrayToJSON(w io.Writer, a Array) error — darwin/amd64, linux/amd64, windows/amd64

+ func IteratorToJSON(w io.Writer, s Iterator) error — darwin/amd64, linux/amd64, windows/amd64

+ func IteratorToJSONArray(w io.Writer, s Iterator) error — darwin/amd64, linux/amd64, windows/amd64

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

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

+ func Scan(d Document, targets ...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

+ func ToJSON(w io.Writer, d Document) 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

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

+ type Document interface

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

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

+ func NewFromJSON(data []byte) (Document, error)

+ 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

+ func NewFieldBuffer() *FieldBuffer

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

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

+ func (fb *FieldBuffer) Delete(field string) error

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

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

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

+ func (fb *FieldBuffer) Reset()

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

+ func (fb *FieldBuffer) Set(f string, v Value)

+ 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(func(d Document) error) error

+ func NewIterator(documents ...Document) Iterator

+ type Keyer interface

+ Key func() []byte

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

+ ScanDocument func(Document) error

+ type Stream struct

+ func NewStream(it Iterator) Stream

+ func (s Stream) Append(it Iterator) Stream

+ func (s Stream) Count() (int, error)

+ func (s Stream) Filter(fn func(d Document) (bool, error)) Stream

+ func (s Stream) First() (d Document, err error)

+ func (s Stream) IsEmpty() bool

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

+ func (s Stream) Limit(n int) Stream

+ func (s Stream) Map(fn func(d Document) (Document, error)) Stream

+ func (s Stream) Offset(n int) Stream

+ func (s Stream) Pipe(op StreamOperator) Stream

+ type StreamOperator func() func(d Document) (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 NewDurationValue(d time.Duration) Value

+ func NewFloat64Value(x float64) Value

+ func NewInt16Value(x int16) Value

+ func NewInt32Value(x int32) Value

+ func NewInt64Value(x int64) Value

+ func NewInt8Value(x int8) Value

+ func NewIntValue(x int) Value

+ func NewNullValue() Value

+ func NewTextValue(x string) Value

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

+ func NewZeroValue(t ValueType) Value

+ func (v Value) Add(u Value) (res Value, err 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) Compare(u Value) int

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

+ func (v Value) ConvertToArray() (Array, error)

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

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

+ func (v Value) ConvertToDocument() (Document, error)

+ func (v Value) ConvertToDuration() (time.Duration, error)

+ func (v Value) ConvertToFloat64() (float64, error)

+ func (v Value) ConvertToInt64() (int64, error)

+ func (v Value) ConvertToText() (string, 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) 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 []Value

+ func NewValueBuffer(values ...Value) ValueBuffer

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

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

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

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

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

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

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

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

+ type ValuePath []string

+ func NewValuePath(p string) ValuePath

+ func (p ValuePath) GetValue(d Document) (Value, error)

+ func (p ValuePath) String() string

+ type ValueType uint8

+ const ArrayValue

+ const BlobValue

+ const BoolValue

+ const DocumentValue

+ const DurationValue

+ const Float64Value

+ const Int16Value

+ const Int32Value

+ const Int64Value

+ const Int8Value

+ const NullValue

+ const TextValue

+ func (t ValueType) IsFloat() bool

+ func (t ValueType) IsInteger() bool

+ func (t ValueType) IsNumber() bool

+ func (t ValueType) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL