bkl

Aug 9, 2024

Changes in this version

+ var ErrNoCloneFound = fmt.Errorf("no document/entry matched $clone (%w)", Err)

type Document

+ func (d *Document) Process(mergeFromDocs []*Document) ([]*Document, error)

May 3, 2024

Changes in this version

+ var ErrVariableNotFound = fmt.Errorf("variable not found (%w)", Err)

Apr 29, 2024

Changes in this version

+ var ErrInvalidRepeat = fmt.Errorf("invalid $repeat (%w)", Err)

type Document

+ Vars map[string]any

+ func (d *Document) Clone() (*Document, error)

Dec 5, 2023

Changes in this version

+ var ErrInvalidArguments = fmt.Errorf("invalid arguments (%w)", Err)

+ type DocID struct

+ type DocPrefix struct

+ func (DocPrefix) Prefix() string

Oct 18, 2023

Changes in this version

+ type Document struct

+ Data any

+ ID typeid.TypeID

+ Parents []*Document

+ func NewDocument() *Document

+ func NewDocumentWithData(data any) *Document

+ func (d *Document) AddParents(parents ...*Document)

+ func (d *Document) AllParents() map[typeid.TypeID]*Document

+ func (d *Document) DataAsMap() map[string]any

+ func (d *Document) PopMapValue(key string) (bool, any)

+ func (d *Document) String() string

type Parser

+ func (p *Parser) MergeDocument(patch *Document) error

Oct 9, 2023

Changes in this version

+ var ErrInvalidParent = fmt.Errorf("invalid $parent (%w)", Err)

Oct 8, 2023

Changes in this version

+ var ErrConflictingParent = fmt.Errorf("conflicting $parent (%w)", Err)

Aug 4, 2023

Changes in this version

+ var ErrMultiMatch = fmt.Errorf("multiple documents $match (%w)", Err)

Jul 29, 2023

Changes in this version

+ var ErrExtraEntries = fmt.Errorf("extra entries (%w)", Err)

+ var ErrMissingEnv = fmt.Errorf("missing environment variable (%w)", Err)

Jul 27, 2023

Changes in this version

+ var ErrCircularRef = fmt.Errorf("circular reference (%w)", Err)

Jul 27, 2023

Changes in this version

+ var ErrMissingMatch = fmt.Errorf("missing $match (%w)", Err)

+ var ErrRefNotFound = fmt.Errorf("reference not found (%w)", Err)

type Parser

+ func (p *Parser) Documents() ([]any, error)

Jul 24, 2023

Changes in this version

+ var ErrExtraKeys = fmt.Errorf("extra keys (%w)", Err)

+ func Process(obj, mergeFrom any) (any, error)

type Format

+ func (f *Format) UnmarshalStream(in []byte) ([]any, error)

Jul 20, 2023

Changes in this version

+ var ErrMarshal = fmt.Errorf("encoding error (%w)", Err)

+ var ErrUnmarshal = fmt.Errorf("decoding error (%w)", Err)

+ type Format struct

+ func GetFormat(name string) (*Format, error)

+ func (f *Format) Marshal(v any) ([]byte, error)

+ func (f *Format) MarshalStream(vs []any) ([]byte, error)

+ func (f *Format) Unmarshal(in []byte) (any, error)

type Parser

+ func (p *Parser) OutputDocuments() ([]any, error)

+ func (p *Parser) OutputDocumentsIndex(index int) ([]any, error)

Jul 18, 2023

Changes in this version

+ var ErrUselessOverride = fmt.Errorf("useless override (%w)", Err)

Jul 14, 2023

Changes in this version

+ var ErrInvalidEncodeType = fmt.Errorf("include $encode type (%w)", ErrInvalidDirective)

Jul 13, 2023

Changes in this version

+ func FileMatch(path string) (string, string, error)

Jul 8, 2023

Changes in this version

+ var Err = fmt.Errorf("bkl error")

+ var ErrDecode = fmt.Errorf("decoding error (%w)", Err)

+ var ErrEncode = fmt.Errorf("encoding error (%w)", Err)

+ var ErrInvalidDirective = fmt.Errorf("invalid directive (%w)", Err)

+ var ErrInvalidFilename = fmt.Errorf("invalid filename (%w)", Err)

+ var ErrInvalidIndex = fmt.Errorf("invalid index (%w)", Err)

+ var ErrInvalidMergeType = fmt.Errorf("invalid $merge type (%w)", ErrInvalidDirective)

+ var ErrInvalidParentType = fmt.Errorf("invalid $parent type (%w)", ErrInvalidDirective)

+ var ErrInvalidPatchType = fmt.Errorf("invalid $patch type (%w)", ErrInvalidDirective)

+ var ErrInvalidPatchValue = fmt.Errorf("invalid $patch value (%w)", ErrInvalidDirective)

+ var ErrInvalidReplaceType = fmt.Errorf("invalid $replace type (%w)", ErrInvalidDirective)

+ var ErrInvalidType = fmt.Errorf("invalid type (%w)", Err)

+ var ErrMergeRefNotFound = fmt.Errorf("$merge reference not found (%w)", ErrInvalidDirective)

+ var ErrMissingFile = fmt.Errorf("missing file (%w)", Err)

+ var ErrNoMatchFound = fmt.Errorf("no document matched $match (%w)", Err)

+ var ErrOutputFile = fmt.Errorf("error opening output file (%w)", Err)

+ var ErrReplaceRefNotFound = fmt.Errorf("$replace reference not found (%w)", ErrInvalidDirective)

+ var ErrRequiredField = fmt.Errorf("required field not set (%w)", Err)

+ var ErrUnknownFormat = fmt.Errorf("unknown format (%w)", Err)

+ type Parser struct

+ func New() *Parser

+ func (p *Parser) Document(index int) (any, error)

+ func (p *Parser) MergeFile(path string) error

+ func (p *Parser) MergeFileLayers(path string) error

+ func (p *Parser) MergeParser(other *Parser) error

+ func (p *Parser) MergePatch(index int, patch any) error

+ func (p *Parser) NumDocuments() int

+ func (p *Parser) Output(ext string) ([]byte, error)

+ func (p *Parser) OutputIndex(index int, ext string) ([][]byte, error)

+ func (p *Parser) OutputToFile(path, format string) error

+ func (p *Parser) OutputToWriter(fh io.Writer, format string) error

+ func (p *Parser) Outputs(ext string) ([][]byte, error)

+ func (p *Parser) SetDebug(debug bool)