Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://couchbase.github.io/couchbase-lite-core/C/html/group___f_l_encoder.html below:

LiteCore: Fleece Encoders

An FLEncoder generates encoded Fleece or JSON data. More...

Note

The functions that write to the encoder do not return error codes, just a 'false' result on error. The actual error is attached to the encoder and can be accessed by calling FLEncoder_GetError or FLEncoder_End.

After an error occurs, the encoder will ignore all subsequent writes.

An FLEncoder generates encoded Fleece or JSON data.

It's sort of a structured output stream, with nesting. There are functions for writing every type of scalar value, and for beginning and ending collections. To write a collection you begin it, write its values, then end it. (Of course a value in a collection can itself be another collection.) When writing a dictionary, you have to call writeKey before writing each value.

Output formats a FLEncoder can generate.

Fleece encoding.

JSON encoding.

JSON5, an extension of JSON with a more readable syntax

Begins writing an array value to an encoder.

This pushes a new state where each subsequent value written becomes an array item, until FLEncoder_EndArray is called.

Parameters

reserveCount Number of array elements to reserve space for. If you know the size of the array, providing it here speeds up encoding slightly. If you don't know, just use zero.

Begins writing a dictionary value to an encoder.

This pushes a new state where each subsequent key and value written are added to the dictionary, until FLEncoder_EndDict is called. Before adding each value, you must call FLEncoder_WriteKey (not FLEncoder_WriteString!), to write the dictionary key.

Parameters

reserveCount Number of dictionary items to reserve space for. If you know the size of the dictionary, providing it here speeds up encoding slightly. If you don't know, just use zero.

Returns the number of bytes encoded so far.

Ends writing an array value; pops back the previous encoding state.

Ends writing a dictionary value; pops back the previous encoding state.

Ends encoding; if there has been no error, it returns the encoded data, else null.

This does not free the FLEncoder; call FLEncoder_Free (or FLEncoder_Reset) next.

Ends encoding; if there has been no error, it returns the encoded Fleece data packaged in an FLDoc.

(This function does not support JSON encoding.) This does not free the FLEncoder; call FLEncoder_Free (or FLEncoder_Reset) next.

Frees the space used by an encoder.

Returns the error code of an encoder, or NoError (0) if there's no error.

Returns the error message of an encoder, or NULL if there's no error.

Returns the user-defined value associated with the encoder; NULL by default.

Creates a new encoder, for generating Fleece data.

Call FLEncoder_Free when done.

Creates a new encoder, allowing some options to be customized.

Parameters

format The output format to generate (Fleece, JSON, or JSON5.) reserveSize The number of bytes to preallocate for the output. (Default is 256) uniqueStrings (Fleece only) If true, string values that appear multiple times will be written as a single shared value. This saves space but makes encoding slightly slower. You should only turn this off if you know you're going to be writing large numbers of non-repeated strings. (Default is true)

Creates a new Fleece encoder that writes to a file, not to memory.

Resets the state of an encoder without freeing it.

It can then be reused to encode another value.

Associates an arbitrary user-defined value with the encoder.

Tells the encoder to use a shared-keys mapping when encoding dictionary keys.

Writes a boolean value (true or false) to an encoder.

Writes a binary data value (a blob) to an encoder.

This can contain absolutely anything including null bytes. If the encoder is generating JSON, the blob will be written as a base64-encoded string.

Writes a timestamp to an encoder, as an ISO-8601 date string.

Note

Since neither Fleece nor JSON have a 'Date' type, the encoded string has no metadata that distinguishes it as a date. It's just a string.)

Parameters

encoder The encoder to write to. ts The timestamp (milliseconds since Unix epoch 1-1-1970). asUTC If true, date is written in UTC (GMT); if false, with the local timezone.

Returns

True on success, false on error.

Writes a 64-bit floating point number to an encoder.

Note

As an implementation detail, the number may be encoded as a 32-bit float or even as an integer, if this can be done without losing precision. For example, 123.0 will be written as an integer, and 123.75 as a float.)

Writes a 32-bit floating point number to an encoder.

Note

As an implementation detail, if the number has no fractional part and can be represented exactly as an integer, it'll be encoded as an integer to save space. This is transparent to the reader, since if it requests the value as a float it'll be returned as floating-point.

Writes an integer to an encoder.

The parameter is typed as int64_t but you can pass any integral type (signed or unsigned) except for huge uint64_ts. The number will be written in a compact form that uses only as many bytes as necessary.

Specifies the key for the next value to be written to the current dictionary.

Specifies the key for the next value to be written to the current dictionary.

The key is given as a Value, which must be a string or integer.

Writes a null value to an encoder.

(This is an explicitly-stored null, like the JSON null, not the "undefined" value represented by a NULL FLValue pointer.)

Writes raw data directly to the encoded output.

(This is not the same as FLEncoder_WriteData, which safely encodes a blob.)

Warning

Do not call this unless you really know what you're doing ... it's quite unsafe, and only used for certain advanced purposes.

Writes a string to an encoder.

The string must be UTF-8-encoded and must not contain any zero bytes.

Warning

Do not use this to write a dictionary key; use FLEncoder_WriteKey instead.

Writes an unsigned integer to an encoder.

Note

This function is only really necessary for huge 64-bit integers greater than or equal to 2^63, which can't be represented as int64_t.

Writes an undefined value to an encoder.

(Its value when read will not be a NULL pointer, but it can be recognized by FLValue_GetType returning kFLUndefined.)

Note

The only real use for writing undefined values is to represent "holes" in an array. An undefined dictionary value should be written simply by skipping the key and value.

Writes a Fleece Value to an Encoder.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4