Couchbase Lite C
Couchbase Lite C API
|
Modules | |
Value Slots | |
An FLSlot is a temporary reference to an element of a mutable Array/Dict; its only purpose is to let you store a value into it, using the FLSlot_... functions. | |
Enumerations | |
enum | FLCopyFlags { kFLDefaultCopy = 0 , kFLDeepCopy = 1 , kFLCopyImmutables = 2 , kFLDeepCopyImmutables = (kFLDeepCopy | kFLCopyImmutables) } |
Option flags for making mutable copies of values. More... | |
Mutable Arrays | |
FLEECE_PUBLIC FLMutableArray FL_NULLABLE | FLArray_MutableCopy (FLArray FL_NULLABLE, FLCopyFlags) |
Creates a new mutable Array that's a copy of the source Array. More... | |
FLEECE_PUBLIC FLMutableArray FL_NULLABLE | FLMutableArray_New (void) |
Creates a new empty mutable Array. More... | |
static FLMutableArray FL_NULLABLE | FLMutableArray_Retain (FLMutableArray FL_NULLABLE d) |
Increments the ref-count of a mutable Array. More... | |
static void | FLMutableArray_Release (FLMutableArray FL_NULLABLE d) |
Decrements the refcount of (and possibly frees) a mutable Array. More... | |
FLEECE_PUBLIC FLArray FL_NULLABLE | FLMutableArray_GetSource (FLMutableArray FL_NULLABLE) |
If the Array was created by FLArray_MutableCopy, returns the original source Array. More... | |
FLEECE_PUBLIC bool | FLMutableArray_IsChanged (FLMutableArray FL_NULLABLE) |
Returns true if the Array has been changed from the source it was copied from. More... | |
FLEECE_PUBLIC void | FLMutableArray_SetChanged (FLMutableArray FL_NULLABLE, bool changed) |
Sets or clears the mutable Array's "changed" flag. More... | |
FLEECE_PUBLIC void | FLMutableArray_Insert (FLMutableArray FL_NULLABLE array, uint32_t firstIndex, uint32_t count) |
Inserts a contiguous range of JSON null values into the array. More... | |
FLEECE_PUBLIC void | FLMutableArray_Remove (FLMutableArray FL_NULLABLE array, uint32_t firstIndex, uint32_t count) |
Removes contiguous items from the array. More... | |
FLEECE_PUBLIC void | FLMutableArray_Resize (FLMutableArray FL_NULLABLE array, uint32_t size) |
Changes the size of an array. More... | |
FLEECE_PUBLIC FLMutableArray FL_NULLABLE | FLMutableArray_GetMutableArray (FLMutableArray FL_NULLABLE, uint32_t index) |
Convenience function for getting an array-valued property in mutable form. More... | |
FLEECE_PUBLIC FLMutableDict FL_NULLABLE | FLMutableArray_GetMutableDict (FLMutableArray FL_NULLABLE, uint32_t index) |
Convenience function for getting an array-valued property in mutable form. More... | |
static void | FLMutableArray_SetNull (FLMutableArray, uint32_t index) |
Stores a JSON null value into an array. More... | |
static void | FLMutableArray_SetBool (FLMutableArray, uint32_t index, bool) |
Stores a boolean value into an array. More... | |
static void | FLMutableArray_SetInt (FLMutableArray, uint32_t index, int64_t) |
Stores an integer into an array. More... | |
static void | FLMutableArray_SetUInt (FLMutableArray, uint32_t index, uint64_t) |
Stores an unsigned integer into an array. More... | |
static void | FLMutableArray_SetFloat (FLMutableArray, uint32_t index, float) |
Stores a 32-bit floating-point number into an array. More... | |
static void | FLMutableArray_SetDouble (FLMutableArray, uint32_t index, double) |
Stores a 64-bit floating point number into an array. More... | |
static void | FLMutableArray_SetString (FLMutableArray, uint32_t index, FLString) |
Stores a UTF-8-encoded string into an array. More... | |
static void | FLMutableArray_SetData (FLMutableArray, uint32_t index, FLSlice) |
Stores a binary data blob into an array. More... | |
static void | FLMutableArray_SetValue (FLMutableArray, uint32_t index, FLValue) |
Stores a Fleece value into an array. More... | |
static void | FLMutableArray_SetArray (FLMutableArray, uint32_t index, FLArray) |
Stores a Fleece array into an array. More... | |
static void | FLMutableArray_SetDict (FLMutableArray, uint32_t index, FLDict) |
Stores a Fleece dictionary into an array. More... | |
static void | FLMutableArray_AppendNull (FLMutableArray) |
Appends a JSON null value to an array. More... | |
static void | FLMutableArray_AppendBool (FLMutableArray, bool) |
Appends a boolean value to an array. More... | |
static void | FLMutableArray_AppendInt (FLMutableArray, int64_t) |
Appends an integer to an array. More... | |
static void | FLMutableArray_AppendUInt (FLMutableArray, uint64_t) |
Appends an unsigned integer to an array. More... | |
static void | FLMutableArray_AppendFloat (FLMutableArray, float) |
Appends a 32-bit floating-point number to an array. More... | |
static void | FLMutableArray_AppendDouble (FLMutableArray, double) |
Appends a 64-bit floating point number to an array. More... | |
static void | FLMutableArray_AppendString (FLMutableArray, FLString) |
Appends a UTF-8-encoded string to an array. More... | |
static void | FLMutableArray_AppendData (FLMutableArray, FLSlice) |
Appends a binary data blob to an array. More... | |
static void | FLMutableArray_AppendValue (FLMutableArray, FLValue) |
Appends a Fleece value to an array. More... | |
static void | FLMutableArray_AppendArray (FLMutableArray, FLArray) |
Appends a Fleece array to an array. More... | |
static void | FLMutableArray_AppendDict (FLMutableArray, FLDict) |
Appends a Fleece dictionary to an array. More... | |
Mutable dictionaries | |
FLEECE_PUBLIC FLMutableDict FL_NULLABLE | FLDict_MutableCopy (FLDict FL_NULLABLE source, FLCopyFlags) |
Creates a new mutable Dict that's a copy of the source Dict. More... | |
FLEECE_PUBLIC FLMutableDict FL_NULLABLE | FLMutableDict_New (void) |
Creates a new empty mutable Dict. More... | |
static FLMutableDict FL_NULLABLE | FLMutableDict_Retain (FLMutableDict FL_NULLABLE d) |
Increments the ref-count of a mutable Dict. More... | |
static void | FLMutableDict_Release (FLMutableDict FL_NULLABLE d) |
Decrements the refcount of (and possibly frees) a mutable Dict. More... | |
FLEECE_PUBLIC FLDict FL_NULLABLE | FLMutableDict_GetSource (FLMutableDict FL_NULLABLE) |
If the Dict was created by FLDict_MutableCopy, returns the original source Dict. More... | |
FLEECE_PUBLIC bool | FLMutableDict_IsChanged (FLMutableDict FL_NULLABLE) |
Returns true if the Dict has been changed from the source it was copied from. More... | |
FLEECE_PUBLIC void | FLMutableDict_SetChanged (FLMutableDict FL_NULLABLE, bool) |
Sets or clears the mutable Dict's "changed" flag. More... | |
FLEECE_PUBLIC void | FLMutableDict_Remove (FLMutableDict FL_NULLABLE, FLString key) |
Removes the value for a key. More... | |
FLEECE_PUBLIC void | FLMutableDict_RemoveAll (FLMutableDict FL_NULLABLE) |
Removes all keys and values. More... | |
FLEECE_PUBLIC FLMutableArray FL_NULLABLE | FLMutableDict_GetMutableArray (FLMutableDict FL_NULLABLE, FLString key) |
Convenience function for getting an array-valued property in mutable form. More... | |
FLEECE_PUBLIC FLMutableDict FL_NULLABLE | FLMutableDict_GetMutableDict (FLMutableDict FL_NULLABLE, FLString key) |
Convenience function for getting a dict-valued property in mutable form. More... | |
static void | FLMutableDict_SetNull (FLMutableDict, FLString key) |
Stores a JSON null value into a mutable dictionary. More... | |
static void | FLMutableDict_SetBool (FLMutableDict, FLString key, bool) |
Stores a boolean value into a mutable dictionary. More... | |
static void | FLMutableDict_SetInt (FLMutableDict, FLString key, int64_t) |
Stores an integer into a mutable dictionary. More... | |
static void | FLMutableDict_SetUInt (FLMutableDict, FLString key, uint64_t) |
Stores an unsigned integer into a mutable dictionary. More... | |
static void | FLMutableDict_SetFloat (FLMutableDict, FLString key, float) |
Stores a 32-bit floating-point number into a mutable dictionary. More... | |
static void | FLMutableDict_SetDouble (FLMutableDict, FLString key, double) |
Stores a 64-bit floating point number into a mutable dictionary. More... | |
static void | FLMutableDict_SetString (FLMutableDict, FLString key, FLString) |
Stores a UTF-8-encoded string into a mutable dictionary. More... | |
static void | FLMutableDict_SetData (FLMutableDict, FLString key, FLSlice) |
Stores a binary data blob into a mutable dictionary. More... | |
static void | FLMutableDict_SetValue (FLMutableDict, FLString key, FLValue) |
Stores a Fleece value into a mutable dictionary. More... | |
static void | FLMutableDict_SetArray (FLMutableDict, FLString key, FLArray) |
Stores a Fleece array into a mutable dictionary. More... | |
static void | FLMutableDict_SetDict (FLMutableDict, FLString key, FLDict) |
Stores a Fleece dictionary into a mutable dictionary. More... | |
Creating string and data values | |
FLEECE_PUBLIC FLValue FL_NULLABLE | FLValue_NewString (FLString) |
Allocates a string value on the heap. More... | |
FLEECE_PUBLIC FLValue FL_NULLABLE | FLValue_NewData (FLSlice) |
Allocates a data/blob value on the heap. More... | |
enum FLCopyFlags |
Option flags for making mutable copies of values.
FLEECE_PUBLIC FLMutableArray FL_NULLABLE FLArray_MutableCopy | ( | FLArray | FL_NULLABLE, |
FLCopyFlags | |||
) |
Creates a new mutable Array that's a copy of the source Array.
Its initial ref-count is 1, so a call to FLMutableArray_Release will free it.
Copying an immutable Array is very cheap (only one small allocation) unless the flag kFLCopyImmutables is set.
Copying a mutable Array is cheap if it's a shallow copy; but if kFLDeepCopy is set, nested mutable Arrays and Dicts are also copied, recursively; if kFLCopyImmutables is also set, immutable values are also copied, recursively.
If the source Array is NULL, then NULL is returned.
FLEECE_PUBLIC FLMutableDict FL_NULLABLE FLDict_MutableCopy | ( | FLDict FL_NULLABLE | source, |
FLCopyFlags | |||
) |
Creates a new mutable Dict that's a copy of the source Dict.
Its initial ref-count is 1, so a call to FLMutableDict_Release will free it.
Copying an immutable Dict is very cheap (only one small allocation.) The deepCopy
flag is ignored.
Copying a mutable Dict is cheap if it's a shallow copy, but if deepCopy
is true, nested mutable Dicts and Arrays are also copied, recursively.
If the source dict is NULL, then NULL is returned.
|
inlinestatic |
Appends a Fleece array to an array.
|
inlinestatic |
Appends a boolean value to an array.
|
inlinestatic |
Appends a binary data blob to an array.
|
inlinestatic |
Appends a Fleece dictionary to an array.
|
inlinestatic |
Appends a 64-bit floating point number to an array.
|
inlinestatic |
Appends a 32-bit floating-point number to an array.
|
inlinestatic |
Appends an integer to an array.
|
inlinestatic |
Appends a JSON null value to an array.
|
inlinestatic |
Appends a UTF-8-encoded string to an array.
|
inlinestatic |
Appends an unsigned integer to an array.
int64_t
.
|
inlinestatic |
Appends a Fleece value to an array.
FLEECE_PUBLIC FLMutableArray FL_NULLABLE FLMutableArray_GetMutableArray | ( | FLMutableArray | FL_NULLABLE, |
uint32_t | index | ||
) |
Convenience function for getting an array-valued property in mutable form.
FLEECE_PUBLIC FLMutableDict FL_NULLABLE FLMutableArray_GetMutableDict | ( | FLMutableArray | FL_NULLABLE, |
uint32_t | index | ||
) |
Convenience function for getting an array-valued property in mutable form.
FLEECE_PUBLIC FLArray FL_NULLABLE FLMutableArray_GetSource | ( | FLMutableArray | FL_NULLABLE | ) |
If the Array was created by FLArray_MutableCopy, returns the original source Array.
FLEECE_PUBLIC void FLMutableArray_Insert | ( | FLMutableArray FL_NULLABLE | array, |
uint32_t | firstIndex, | ||
uint32_t | count | ||
) |
Inserts a contiguous range of JSON null
values into the array.
array | The array to operate on. |
firstIndex | The zero-based index of the first value to be inserted. |
count | The number of items to insert. |
FLEECE_PUBLIC bool FLMutableArray_IsChanged | ( | FLMutableArray | FL_NULLABLE | ) |
Returns true if the Array has been changed from the source it was copied from.
FLEECE_PUBLIC FLMutableArray FL_NULLABLE FLMutableArray_New | ( | void | ) |
Creates a new empty mutable Array.
Its initial ref-count is 1, so a call to FLMutableArray_Release will free it.
|
inlinestatic |
Decrements the refcount of (and possibly frees) a mutable Array.
FLEECE_PUBLIC void FLMutableArray_Remove | ( | FLMutableArray FL_NULLABLE | array, |
uint32_t | firstIndex, | ||
uint32_t | count | ||
) |
Removes contiguous items from the array.
array | The array to operate on. |
firstIndex | The zero-based index of the first item to remove. |
count | The number of items to remove. |
FLEECE_PUBLIC void FLMutableArray_Resize | ( | FLMutableArray FL_NULLABLE | array, |
uint32_t | size | ||
) |
Changes the size of an array.
If the new size is larger, the array is padded with JSON null
values. If it's smaller, values are removed from the end.
|
inlinestatic |
Increments the ref-count of a mutable Array.
|
inlinestatic |
Stores a Fleece array into an array.
|
inlinestatic |
Stores a boolean value into an array.
FLEECE_PUBLIC void FLMutableArray_SetChanged | ( | FLMutableArray | FL_NULLABLE, |
bool | changed | ||
) |
Sets or clears the mutable Array's "changed" flag.
|
inlinestatic |
Stores a binary data blob into an array.
|
inlinestatic |
Stores a Fleece dictionary into an array.
|
inlinestatic |
Stores a 64-bit floating point number into an array.
|
inlinestatic |
Stores a 32-bit floating-point number into an array.
|
inlinestatic |
Stores an integer into an array.
|
inlinestatic |
Stores a JSON null value into an array.
|
inlinestatic |
Stores a UTF-8-encoded string into an array.
|
inlinestatic |
Stores an unsigned integer into an array.
int64_t
.
|
inlinestatic |
Stores a Fleece value into an array.
FLEECE_PUBLIC FLMutableArray FL_NULLABLE FLMutableDict_GetMutableArray | ( | FLMutableDict | FL_NULLABLE, |
FLString | key | ||
) |
Convenience function for getting an array-valued property in mutable form.
FLEECE_PUBLIC FLMutableDict FL_NULLABLE FLMutableDict_GetMutableDict | ( | FLMutableDict | FL_NULLABLE, |
FLString | key | ||
) |
Convenience function for getting a dict-valued property in mutable form.
FLEECE_PUBLIC FLDict FL_NULLABLE FLMutableDict_GetSource | ( | FLMutableDict | FL_NULLABLE | ) |
If the Dict was created by FLDict_MutableCopy, returns the original source Dict.
FLEECE_PUBLIC bool FLMutableDict_IsChanged | ( | FLMutableDict | FL_NULLABLE | ) |
Returns true if the Dict has been changed from the source it was copied from.
FLEECE_PUBLIC FLMutableDict FL_NULLABLE FLMutableDict_New | ( | void | ) |
Creates a new empty mutable Dict.
Its initial ref-count is 1, so a call to FLMutableDict_Release will free it.
|
inlinestatic |
Decrements the refcount of (and possibly frees) a mutable Dict.
FLEECE_PUBLIC void FLMutableDict_Remove | ( | FLMutableDict | FL_NULLABLE, |
FLString | key | ||
) |
Removes the value for a key.
FLEECE_PUBLIC void FLMutableDict_RemoveAll | ( | FLMutableDict | FL_NULLABLE | ) |
Removes all keys and values.
|
inlinestatic |
Increments the ref-count of a mutable Dict.
|
inlinestatic |
Stores a Fleece array into a mutable dictionary.
|
inlinestatic |
Stores a boolean value into a mutable dictionary.
FLEECE_PUBLIC void FLMutableDict_SetChanged | ( | FLMutableDict | FL_NULLABLE, |
bool | |||
) |
Sets or clears the mutable Dict's "changed" flag.
|
inlinestatic |
Stores a binary data blob into a mutable dictionary.
|
inlinestatic |
Stores a Fleece dictionary into a mutable dictionary.
|
inlinestatic |
Stores a 64-bit floating point number into a mutable dictionary.
|
inlinestatic |
Stores a 32-bit floating-point number into a mutable dictionary.
|
inlinestatic |
Stores an integer into a mutable dictionary.
|
inlinestatic |
Stores a JSON null value into a mutable dictionary.
|
inlinestatic |
Stores a UTF-8-encoded string into a mutable dictionary.
|
inlinestatic |
Stores an unsigned integer into a mutable dictionary.
int64_t
.
|
inlinestatic |
Stores a Fleece value into a mutable dictionary.
FLEECE_PUBLIC FLValue FL_NULLABLE FLValue_NewData | ( | FLSlice | ) |
Allocates a data/blob value on the heap.
This is rarely needed – usually you'd just add data to a mutable Array or Dict directly using one of their "...SetData or "...AppendData" methods.
FLEECE_PUBLIC FLValue FL_NULLABLE FLValue_NewString | ( | FLString | ) |
Allocates a string value on the heap.
This is rarely needed – usually you'd just add a string to a mutable Array or Dict directly using one of their "...SetString" or "...AppendString" methods.