Copies the string pointed by value into the buffer provided at buffer of buflen bytes.
│ │ │If buffer is a NULL pointer, this function will not copy anything and will only update the next value.
│ │ │If the iterator value does not point to a byte string, the behaviour is undefined, so checking with cbor_value_get_type or cbor_value_is_byte_string is recommended.
│ │ │If the provided buffer length was too small, this function returns an error condition of CborErrorOutOfMemory. If you need to calculate the length of the string in order to preallocate a buffer, use cbor_value_calculate_string_length().
│ │ │On success, this function sets the number of bytes copied to *buflen. If the buffer is large enough, this function will insert a null byte after the last copied byte, to facilitate manipulation of null-terminated strings. That byte is not included in the returned value of *buflen.
The next pointer, if not null, will be updated to point to the next item after this string. If value points to the last item, then next will be invalid.
│ │ │This function may not run in constant time (it will run in O(n) time on the number of chunks). It requires constant memory (O(1)).
│ │ │ -If buffer is a NULL pointer, this function will not copy anything and will only update the next value.
│ │ │If the iterator value does not point to a text string, the behaviour is undefined, so checking with cbor_value_get_type or cbor_value_is_text_string is recommended.
│ │ │If the provided buffer length was too small, this function returns an error condition of CborErrorOutOfMemory. If you need to calculate the length of the string in order to preallocate a buffer, use cbor_value_calculate_string_length().
│ │ │On success, this function sets the number of bytes copied to *buflen. If the buffer is large enough, this function will insert a null byte after the last copied byte, to facilitate manipulation of text strings. That byte is not included in the returned value of *buflen. If there was no space for the terminating null, no error is returned, so callers must check the value of *buflen after the call, before relying on the '\0'; if it has not been changed by the call, there is no '\0'-termination on the buffer's contents.
The next pointer, if not null, will be updated to point to the next item after this string. If value points to the last item, then next will be invalid.
│ │ │This function may not run in constant time (it will run in O(n) time on the number of chunks). It requires constant memory (O(1)).
│ │ │Retrieves the CBOR half-precision floating point (16-bit) value that value points to and stores it in result.
│ │ │If the iterator value does not point to a half-precision floating point value, the behavior is undefined, so checking with cbor_value_get_type or with cbor_value_is_half_float is recommended.
│ │ │Note: since the C language does not have a standard type for half-precision floating point, this function takes a void * as a parameter for the storage area, which must be at least 16 bits wide.
│ │ │ -Referenced by cbor_value_get_half_float_as_float().
│ │ │ +Referenced by cbor_value_get_half_float_as_float().
│ │ │ │ │ │If the iterator value does not point to a text string, the behaviour is undefined, so checking with cbor_value_get_type or cbor_value_is_text_string is recommended.
│ │ │The next pointer, if not null, will be updated to point to the next item after this string. During iteration, the pointer must only be passed back again to this function; passing it to any other function in this library results in undefined behavior. If there are no more chunks to be read from value, then next will be set to the next item after this string; if value points to the last item, then next will be invalid.
│ │ │Returns true if the iterator value is valid and points to a CBOR byte string.
│ │ │CBOR byte strings are binary data with no specified encoding or format.
│ │ │ -Referenced by cbor_value_copy_byte_string(), cbor_value_dup_byte_string(), and cbor_value_get_string_length().
│ │ │ +Referenced by cbor_value_copy_byte_string(), cbor_value_dup_byte_string(), and cbor_value_get_string_length().
│ │ │ │ │ │Returns true if the iterator value is valid and points to a CBOR text string.
│ │ │CBOR text strings are UTF-8 encoded and usually contain human-readable text.
│ │ │ -Referenced by cbor_value_copy_text_string(), cbor_value_dup_text_string(), cbor_value_get_string_length(), cbor_value_get_text_string_chunk(), cbor_value_map_find_value(), and cbor_value_text_string_equals().
│ │ │ +Referenced by cbor_value_copy_text_string(), cbor_value_dup_text_string(), cbor_value_get_string_length(), cbor_value_get_text_string_chunk(), cbor_value_map_find_value(), and cbor_value_text_string_equals().
│ │ │ │ │ │Converts the current CBOR type pointed by value to its textual representation and writes it to the stream by calling the streamFunction.
│ │ │If an error occurs, this function returns an error code similar to Parsing CBOR streams.
│ │ │The textual representation can be controlled by the flags parameter (see CborPrettyFlags for more information).
│ │ │If no error ocurred, this function advances value to the next element. Often, concatenating the text representation of multiple elements can be done by appending a comma to the output stream in between calls to this function.
│ │ │The streamFunction function will be called with the token value as the first parameter and a printf-style format string as the second, with a variable number of further parameters.
│ │ │ - │ │ │ + │ │ │ │ │ │ -Referenced by cbor_value_to_pretty_advance(), and cbor_value_to_pretty_advance_flags().
│ │ │ +Referenced by cbor_value_to_pretty_advance(), and cbor_value_to_pretty_advance_flags().
│ │ │ │ │ │ 1.15.0
│ │ ├── ./usr/share/doc/libtinycbor-dev/html/a00058.html
│ │ │ @@ -101,15 +101,15 @@
│ │ │ Converts the current CBOR type pointed to by value to JSON and writes that to the out stream.
│ │ │If an error occurs, this function returns an error code similar to CborParsing. The flags parameter indicates one or more of the flags from CborToJsonFlags that control the conversion.
│ │ │ - │ │ │ + │ │ │ │ │ │Converts the current CBOR type pointed to by value to JSON and writes that to the out stream.
│ │ │If an error occurs, this function returns an error code similar to CborParsing. The flags parameter indicates one or more of the flags from CborToJsonFlags that control the conversion.
│ │ │If no error ocurred, this function advances value to the next element.
│ │ │ - │ │ │ + │ │ │ │ │ │Referenced by cbor_value_to_json().
│ │ │ │ │ │| cbor.h | > The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue) |
| cborjson.h | > The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON |
| memory.h | |
| tinycbor-version.h | |
| cbor.h | > The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue) |
| cborjson.h | > The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON |
| memory.h | |
| tinycbor-version.h |
1.15.0
│ │ │
│ │ ├── ./usr/share/doc/libtinycbor-dev/html/globals.html
│ │ │ @@ -111,22 +111,22 @@
│ │ │ > The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON. │ │ │ +
> The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON. │ │ │ More...
│ │ │ -#include "cbor.h"#include "cbor.h"Go to the source code of this file.
│ │ │ +Go to the source code of this file.
│ │ ││ │ │ Functions | |
| CborError | cbor_value_to_json_advance (FILE *out, CborValue *value, int flags) |
| Converts the current CBOR type pointed to by value to JSON and writes that to the out stream. | |
| CborError | cbor_value_to_json (FILE *out, const CborValue *value, int flags) |
| Converts the current CBOR type pointed to by value to JSON and writes that to the out stream. | |
> The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON.
│ │ │ -> The <cborjson.h> file contains the routines that are used to convert a CBOR data stream into JSON.
│ │ │ + 1.15.0
│ │ │
│ │ │ 1.15.0
│ │ │ --- ./usr/share/doc/libtinycbor-dev/html/a00047.html
│ │ ├── +++ ./usr/share/doc/libtinycbor-dev/html/a00014.html
│ │ │┄ Files 99% similar despite different names
│ │ │ @@ -51,26 +51,26 @@
│ │ │ Typedefs |
│ │ │ Functions |
│ │ │ Variables > The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue). │ │ │ +
> The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue). │ │ │ More...
│ │ │#include <assert.h>#include <limits.h>#include <stddef.h>#include <stdint.h>#include <string.h>#include <stdio.h>#include "tinycbor-version.h"#include <stdbool.h>Go to the source code of this file.
│ │ │ +Go to the source code of this file.
│ │ ││ │ │ Data Structures | |
| struct | CborEncoder |
| Structure used to encode to CBOR. More... | |
| struct | CborValue |
| This type contains one value parsed from the CBOR stream. More... | |
│ │ │ Variables | |
| static const size_t | CborIndefiniteLength = ((size_t)-1) |
| This variable is a constant used to indicate that the length of the map or array is not yet determined. | |
> The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue).
│ │ │ -> The <cbor.h> is the main header in TinyCBOR and defines the constants used by most functions as well as the structures for encoding (CborEncoder) and decoding (CborValue).
│ │ │ +