Couchbase Lite C
Couchbase Lite C API
Typedefs | Functions
Fleece Paths

An FLKeyPath Describes a location in a Fleece object tree, as a path from the root that follows dictionary properties and array elements. More...

Typedefs

typedef struct _FLKeyPath * FLKeyPath
 A reference to a key path. More...
 

Functions

FLEECE_PUBLIC FLKeyPath FL_NULLABLE FLKeyPath_New (FLSlice specifier, FLError *FL_NULLABLE outError)
 Creates a new FLKeyPath object by compiling a path specifier string. More...
 
FLEECE_PUBLIC void FLKeyPath_Free (FLKeyPath FL_NULLABLE)
 Frees a compiled FLKeyPath object. More...
 
FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_Eval (FLKeyPath, FLValue root)
 Evaluates a compiled key-path for a given Fleece root object. More...
 
FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_EvalOnce (FLSlice specifier, FLValue root, FLError *FL_NULLABLE outError)
 Evaluates a key-path from a specifier string, for a given Fleece root object. More...
 
FLEECE_PUBLIC FLStringResult FLKeyPath_ToString (FLKeyPath path)
 Returns a path in string form. More...
 
FLEECE_PUBLIC bool FLKeyPath_Equals (FLKeyPath path1, FLKeyPath path2)
 Equality test. More...
 
FLEECE_PUBLIC bool FLKeyPath_GetElement (FLKeyPath, size_t i, FLSlice *outDictKey, int32_t *outArrayIndex)
 Returns an element of a path, either a key or an array index. More...
 

Detailed Description

An FLKeyPath Describes a location in a Fleece object tree, as a path from the root that follows dictionary properties and array elements.

It's similar to a JSONPointer or an Objective-C KeyPath, but simpler (so far.) The path is compiled into an efficient form that can be traversed quickly.

It looks like foo.bar[2][-3].baz – that is, properties prefixed with a ., and array indexes in brackets. (Negative indexes count from the end of the array.)

A leading JSONPath-like $. is allowed but ignored.

A '\' can be used to escape a special character ('.', '[' or '$') at the start of a property name (but not yet in the middle of a name.)

Typedef Documentation

◆ FLKeyPath

typedef struct _FLKeyPath* FLKeyPath

A reference to a key path.

Function Documentation

◆ FLKeyPath_Equals()

FLEECE_PUBLIC bool FLKeyPath_Equals ( FLKeyPath  path1,
FLKeyPath  path2 
)

Equality test.

◆ FLKeyPath_Eval()

FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_Eval ( FLKeyPath  ,
FLValue  root 
)

Evaluates a compiled key-path for a given Fleece root object.

◆ FLKeyPath_EvalOnce()

FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_EvalOnce ( FLSlice  specifier,
FLValue  root,
FLError *FL_NULLABLE  outError 
)

Evaluates a key-path from a specifier string, for a given Fleece root object.

If you only need to evaluate the path once, this is a bit faster than creating an FLKeyPath object, evaluating, then freeing it.

◆ FLKeyPath_Free()

FLEECE_PUBLIC void FLKeyPath_Free ( FLKeyPath  FL_NULLABLE)

Frees a compiled FLKeyPath object.

(It's ok to pass NULL.)

◆ FLKeyPath_GetElement()

FLEECE_PUBLIC bool FLKeyPath_GetElement ( FLKeyPath  ,
size_t  i,
FLSlice outDictKey,
int32_t *  outArrayIndex 
)

Returns an element of a path, either a key or an array index.

◆ FLKeyPath_New()

FLEECE_PUBLIC FLKeyPath FL_NULLABLE FLKeyPath_New ( FLSlice  specifier,
FLError *FL_NULLABLE  outError 
)

Creates a new FLKeyPath object by compiling a path specifier string.

◆ FLKeyPath_ToString()

FLEECE_PUBLIC FLStringResult FLKeyPath_ToString ( FLKeyPath  path)

Returns a path in string form.