document

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 21, 2021 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package document defines types to manipulate and compare documents and values.

Index

Constants

This section is empty.

Variables

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

ErrFieldNotFound must be returned by Document implementations, when calling the GetByField method and the field wasn't found in the document.

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

ErrValueNotFound must be returned by Array implementations, when calling the GetByIndex method and the index wasn't found in the array.

Functions

func ArrayContains 

func ArrayContains(a types.Array, v types.Value) (bool, error)

ArrayContains iterates over a and returns whether v is equal to one of its values.

func ArrayLength 

func ArrayLength(a types.Array) (int, error)

ArrayLength returns the length of an array.

func CastAs added in v0.13.0 

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

CastAs casts v as the selected type when possible.

func CastAsArray added in v0.13.0 

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

CastAsArray casts according to the following rules: Text: decodes a JSON array, otherwise fails. Any other type is considered an invalid cast.

func CastAsBlob added in v0.13.0 

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

CastAsBlob casts according to the following rules: Text: decodes a base64 string, otherwise fails. Any other type is considered an invalid cast.

func CastAsBool added in v0.13.0 

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

CastAsBool casts according to the following rules: Integer: true if truthy, otherwise false. Text: uses strconv.Parsebool to determine the boolean value, it fails if the text doesn't contain a valid boolean. Any other type is considered an invalid cast.

func CastAsDocument added in v0.13.0 

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

CastAsDocument casts according to the following rules: Text: decodes a JSON object, otherwise fails. Any other type is considered an invalid cast.

func CastAsDouble added in v0.13.0 

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

CastAsDouble casts according to the following rules: Integer: returns a double version of the integer. Text: uses strconv.ParseFloat to determine the double value, it fails if the text doesn't contain a valid float value. Any other type is considered an invalid cast.

func CastAsInteger added in v0.13.0 

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

CastAsInteger casts according to the following rules: Bool: returns 1 if true, 0 if false. Double: cuts off the decimal and remaining numbers. Text: uses strconv.ParseInt to determine the integer value, then casts it to an integer. If it fails uses strconv.ParseFloat to determine the double value, then casts it to an integer It fails if the text doesn't contain a valid float value. Any other type is considered an invalid cast.

func CastAsText added in v0.13.0 

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

CastAsText returns a JSON representation of v. If the representation is a string, it gets unquoted.

func Fields added in v0.8.0 

func Fields(d types.Document) ([]string, error)

Fields returns a list of all the fields at the root of the document sorted lexicographically.

func Length 

func Length(d types.Document) (int, error)

Length returns the length of a document.

func MapScan 

func MapScan(d types.Document, t interface{}) error

MapScan decodes the document into a map.

func MarshalJSON added in v0.8.0 

func MarshalJSON(d types.Document) ([]byte, error)

MarshalJSON encodes a document to json.

func MarshalJSONArray added in v0.8.0 

func MarshalJSONArray(a types.Array) ([]byte, error)

MarshalJSONArray encodes an array to json.

func NewFromCSV added in v0.13.0 

func NewFromCSV(headers, columns []string) types.Document

NewFromCSV takes a list of headers and columns and returns a document. Each header will be assigned as the key and each corresponding column as a text value. The length of headers and columns must be the same.

func NewFromJSON 

func NewFromJSON(data []byte) types.Document

NewFromJSON creates a document from raw JSON data. The returned document will lazily decode the data. If data is not a valid json object, calls to Iterate or GetByField will return an error.

func NewFromMap 

func NewFromMap(m interface{}) (types.Document, error)

NewFromMap creates a document from a map. Due to the way maps are designed, iteration order is not guaranteed.

func NewFromStruct 

func NewFromStruct(s interface{}) (types.Document, error)

NewFromStruct creates a document from a struct using reflection.

func NewValue 

func NewValue(x interface{}) (types.Value, error)

NewValue creates a value whose type is infered from x.

func Scan 

func Scan(d types.Document, targets ...interface{}) error

Scan each field of the document into the given variables.

func ScanDocument added in v0.13.0 

func ScanDocument(d types.Document, t interface{}) error

ScanDocument scans a document into dest which must be either a struct pointer, a map or a map pointer.

func ScanIterator added in v0.13.0 

func ScanIterator(it Iterator, t interface{}) error

ScanIterator scans a document iterator into a slice or fixed size array. t must be a pointer to a valid slice or array.

It t is a slice pointer and its capacity is too low, a new slice will be allocated. Otherwise, its length is set to 0 so that its content is overwritten.

If t is an array pointer, its capacity must be bigger than the length of a, otherwise an error is returned.

func ScanValue 

func ScanValue(v types.Value, t interface{}) error

ScanValue scans v into t.

func SliceScan 

func SliceScan(a types.Array, t interface{}) error

SliceScan scans a document array into a slice or fixed size array. t must be a pointer to a valid slice or array.

It t is a slice pointer and its capacity is too low, a new slice will be allocated. Otherwise, its length is set to 0 so that its content is overwritten.

If t is an array pointer, its capacity must be bigger than the length of a, otherwise an error is returned.

func StructScan 

func StructScan(d types.Document, t interface{}) error

StructScan scans d into t. t is expected to be a pointer to a struct.

By default, each struct field name is lowercased and the document's GetByField method is called with that name. If there is a match, the value is converted to the struct field type when possible, otherwise an error is returned. The decoding of each struct field can be customized by the format string stored under the "genji" key stored in the struct field's tag. The content of the format string is used instead of the struct field name and passed to the GetByField method.

func ValueToJSON added in v0.13.0 

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

MarshalJSON implements the json.Marshaler interface.

func ValueToString added in v0.13.0 

func ValueToString(v types.Value) string

Types

type ErrUnsupportedType 

type ErrUnsupportedType struct {
	Value interface{}
	Msg   string
}

ErrUnsupportedType is used to skip struct or array fields that are not supported.

func (*ErrUnsupportedType) Error 

func (e *ErrUnsupportedType) Error() string

type FieldBuffer 

type FieldBuffer struct {
	EncodedKey []byte
	DecodedKey types.Value
	// contains filtered or unexported fields
}

FieldBuffer stores a group of fields in memory. It implements the Document interface.

func NewFieldBuffer 

func NewFieldBuffer() *FieldBuffer

NewFieldBuffer creates a FieldBuffer.

func (*FieldBuffer) Add 

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

Add a field to the buffer.

func (*FieldBuffer) Apply added in v0.9.0 

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

Apply a function to all the values of the buffer.

func (*FieldBuffer) Clone added in v0.10.0 

func (fb *FieldBuffer) Clone() *FieldBuffer

Clone the buffer.

func (*FieldBuffer) Copy 

func (fb *FieldBuffer) Copy(d types.Document) error

Copy deep copies every value of the document to the buffer. If a value is a document or an array, it will be stored as a FieldBuffer or ValueBuffer respectively.

func (*FieldBuffer) Delete 

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

Delete a field from the buffer.

func (*FieldBuffer) Fields added in v0.8.0 

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

Fields returns a sorted list of root field names.

func (FieldBuffer) GetByField 

func (fb FieldBuffer) GetByField(field string) (types.Value, error)

GetByField returns a value by field. Returns an error if the field doesn't exists.

func (FieldBuffer) Iterate 

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

Iterate goes through all the fields of the document and calls the given function by passing each one of them. If the given function returns an error, the iteration stops.

func (*FieldBuffer) Key 

func (fb *FieldBuffer) Key() (types.Value, error)

Key of the document, if any.

func (FieldBuffer) Len 

func (fb FieldBuffer) Len() int

Len of the buffer.

func (*FieldBuffer) MarshalJSON 

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

MarshalJSON implements the json.Marshaler interface.

func (*FieldBuffer) RawKey added in v0.10.0 

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

RawKey returns the encoded key of the document, if any.

func (*FieldBuffer) Replace 

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

Replace the value of the field by v.

func (*FieldBuffer) Reset 

func (fb *FieldBuffer) Reset()

Reset the buffer.

func (*FieldBuffer) ScanDocument 

func (fb *FieldBuffer) ScanDocument(d types.Document) error

ScanDocument copies all the fields of d to the buffer.

func (*FieldBuffer) Set 

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

Set replaces a field if it already exists or creates one if not.

func (*FieldBuffer) String added in v0.12.0 

func (fb *FieldBuffer) String() string

func (*FieldBuffer) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaler interface.

type Iterator 

type Iterator interface {
	// Iterate goes through all the documents and calls the given function by passing each one of them.
	// If the given function returns an error, the iteration stops.
	Iterate(fn func(d types.Document) error) error
}

An Iterator can iterate over documents.

type JsonArray added in v0.13.0 

type JsonArray struct {
	types.Array
}

func (JsonArray) MarshalJSON added in v0.13.0 

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

type JsonDocument added in v0.13.0 

type JsonDocument struct {
	types.Document
}

func (JsonDocument) MarshalJSON added in v0.13.0 

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

type Keyer 

type Keyer interface {
	RawKey() []byte
	Key() (types.Value, error)
}

A Keyer returns the key identifying documents in their storage. This is usually implemented by documents read from storages.

type Path added in v0.9.0 

type Path []PathFragment

A Path represents the path to a particular value within a document.

func NewPath added in v0.10.0 

func NewPath(fragments ...string) Path

NewPath creates a path from a list of strings representing either a field name or an array index in string form.

func (Path) Clone added in v0.12.0 

func (p Path) Clone() Path

func (Path) GetValueFromArray added in v0.10.0 

func (p Path) GetValueFromArray(a types.Array) (types.Value, error)

GetValueFromArray returns the value at path p from a.

func (Path) GetValueFromDocument added in v0.10.0 

func (p Path) GetValueFromDocument(d types.Document) (types.Value, error)

GetValueFromDocument returns the value at path p from d.

func (Path) IsEqual added in v0.9.0 

func (p Path) IsEqual(other Path) bool

IsEqual returns whether other is equal to p.

func (Path) String added in v0.9.0 

func (p Path) String() string

String representation of all the fragments of the path. It implements the Stringer interface.

type PathFragment added in v0.9.0 

type PathFragment struct {
	FieldName  string
	ArrayIndex int
}

PathFragment is a fragment of a path representing either a field name or the index of an array.

type Scanner 

type Scanner interface {
	ScanDocument(types.Document) error
}

A Scanner can iterate over a document and scan all the fields.

type ValueBuffer 

type ValueBuffer struct {
	Values []types.Value
}

ValueBuffer is an array that holds values in memory.

func NewValueBuffer 

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

NewValueBuffer creates a buffer of values.

func SortArray 

func SortArray(a types.Array) (*ValueBuffer, error)

SortArray creates a new sorted array. Types are sorted in the following ascending order:

  • NULL
  • Booleans
  • Numbers
  • Text
  • Blob
  • Arrays
  • Documents

It doesn't sort nested arrays.

func (*ValueBuffer) Append 

func (vb *ValueBuffer) Append(v types.Value) *ValueBuffer

Append a value to the buffer and return a new buffer.

func (*ValueBuffer) Apply added in v0.9.0 

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

Apply a function to all the values of the buffer.

func (*ValueBuffer) Copy 

func (vb *ValueBuffer) Copy(a types.Array) error

Copy deep copies all the values from the given array. If a value is a document or an array, it will be stored as a *FieldBuffer or *ValueBuffer respectively.

func (*ValueBuffer) GetByIndex 

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

GetByIndex returns a value set at the given index. If the index is out of range it returns an error.

func (*ValueBuffer) IsEqual added in v0.12.0 

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

IsEqual compares two ValueBuffer and returns true if and only if both each values and types are respectively equal.

func (*ValueBuffer) Iterate 

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

Iterate over all the values of the buffer. It implements the Array interface.

func (*ValueBuffer) Len added in v0.10.0 

func (vb *ValueBuffer) Len() int

Len returns the length the of array

func (ValueBuffer) MarshalJSON 

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

MarshalJSON implements the json.Marshaler interface.

func (*ValueBuffer) Replace 

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

Replace the value of the index by v.

func (*ValueBuffer) ScanArray 

func (vb *ValueBuffer) ScanArray(a types.Array) error

ScanArray copies all the values of a to the buffer.

func (*ValueBuffer) Types added in v0.12.0 

func (vb *ValueBuffer) Types() []types.ValueType

func (*ValueBuffer) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaler interface.

Source Files

View all Source files

Directories

Path Synopsis
Package encoding defines types that deal with document encoding.
 Package encoding defines types that deal with document encoding.
custom
encodingtest
Package encodingtest provides a test suite for testing codec implementations.
 Package encodingtest provides a test suite for testing codec implementations.
msgpack

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.