qcbor_common.h File Reference

Go to the source code of this file.

Macros
#define	QCBOR_VERSION_MAJOR   2
#define	QCBOR_VERSION_MINOR   0
#define	QCBOR_VERSION_PATCH   0
#define	QCBOR_SPIFFY_DECODE
#define	CBOR_MAJOR_TYPE_POSITIVE_INT   0
#define	CBOR_MAJOR_TYPE_NEGATIVE_INT   1
#define	CBOR_MAJOR_TYPE_BYTE_STRING   2
#define	CBOR_MAJOR_TYPE_TEXT_STRING   3
#define	CBOR_MAJOR_TYPE_ARRAY   4
#define	CBOR_MAJOR_TYPE_MAP   5
#define	CBOR_MAJOR_TYPE_TAG   6
#define	CBOR_MAJOR_TYPE_OPTIONAL   6
#define	CBOR_MAJOR_TYPE_SIMPLE   7
#define	CBOR_TAG_DATE_STRING   0
#define	CBOR_TAG_DATE_EPOCH   1
#define	CBOR_TAG_POS_BIGNUM   2
#define	CBOR_TAG_NEG_BIGNUM   3
#define	CBOR_TAG_DECIMAL_FRACTION   4
#define	CBOR_TAG_BIGFLOAT   5
#define	CBOR_TAG_COSE_ENCRYPT0   16
#define	CBOR_TAG_COSE_ENCRYPTO   16
#define	CBOR_TAG_COSE_MAC0   17
#define	CBOR_TAG_COSE_SIGN1   18
#define	CBOR_TAG_ENC_AS_B64URL   21
#define	CBOR_TAG_ENC_AS_B64   22
#define	CBOR_TAG_ENC_AS_B16   23
#define	CBOR_TAG_CBOR   24
#define	CBOR_TAG_URI   32
#define	CBOR_TAG_B64URL   33
#define	CBOR_TAG_B64   34
#define	CBOR_TAG_REGEX   35
#define	CBOR_TAG_MIME   36
#define	CBOR_TAG_BIN_UUID   37
#define	CBOR_TAG_CWT   61
#define	CBOR_TAG_CBOR_SEQUENCE   63
#define	CBOR_TAG_COSE_ENCRYPT   96
#define	CBOR_TAG_ENCRYPT   96
#define	CBOR_TAG_COSE_MAC   97
#define	CBOR_TAG_MAC   97
#define	CBOR_TAG_COSE_SIGN   98
#define	CBOR_TAG_SIGN   98
#define	CBOR_TAG_DAYS_EPOCH   100
#define	CBOR_TAG_GEO_COORD   103
#define	CBOR_TAG_BINARY_MIME   257
#define	CBOR_TAG_DAYS_STRING   1004
#define	CBOR_TAG_CBOR_MAGIC   55799
#define	CBOR_TAG_INVALID16   0xffff
#define	CBOR_TAG_INVALID32   0xffffffff
#define	CBOR_TAG_INVALID64   0xffffffffffffffff
#define	CBOR_TAG_ANY   (CBOR_TAG_INVALID64 - 1)
#define	QCBOR_START_OF_NOT_WELL_FORMED_ERRORS   20
#define	QCBOR_START_OF_UNRECOVERABLE_DECODE_ERRORS   30
#define	QCBOR_END_OF_NOT_WELL_FORMED_ERRORS   39
#define	QCBOR_END_OF_UNRECOVERABLE_DECODE_ERRORS   59
#define	QCBOR_MAX_ARRAY_NESTING   15
#define	QCBOR_MAX_ITEMS_IN_ARRAY
#define	QCBOR_MAX_ITEMS_IN_MAP   (QCBOR_MAX_ITEMS_IN_ARRAY/2)

Enumerations
enum	QCBORError {   QCBOR_SUCCESS = 0 , QCBOR_ERR_BUFFER_TOO_SMALL = 1 , QCBOR_ERR_ENCODE_UNSUPPORTED = 2 , QCBOR_ERR_BUFFER_TOO_LARGE = 3 ,   QCBOR_ERR_ARRAY_NESTING_TOO_DEEP = 4 , QCBOR_ERR_CLOSE_MISMATCH = 5 , QCBOR_ERR_ARRAY_TOO_LONG = 6 , QCBOR_ERR_TOO_MANY_CLOSES = 7 ,   QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN = 8 , QCBOR_ERR_OPEN_BYTE_STRING = 9 , QCBOR_ERR_CANNOT_CANCEL = 10 , QCBOR_ERR_BAD_TYPE_7 = 20 ,   QCBOR_ERR_EXTRA_BYTES = 21 , QCBOR_ERR_UNSUPPORTED = 22 , QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED = 23 , QCBOR_ERR_BAD_INT = 24 ,   QCBOR_ERR_INDEFINITE_STRING_CHUNK = 30 , QCBOR_ERR_HIT_END = 31 , QCBOR_ERR_BAD_BREAK = 32 , QCBOR_ERR_INPUT_TOO_LARGE = 40 ,   QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP = 41 , QCBOR_ERR_ARRAY_DECODE_TOO_LONG = 42 , QCBOR_ERR_STRING_TOO_LONG = 43 , QCBOR_ERR_BAD_EXP_AND_MANTISSA = 44 ,   QCBOR_ERR_NO_STRING_ALLOCATOR = 45 , QCBOR_ERR_STRING_ALLOCATE = 46 , QCBOR_ERR_MAP_LABEL_TYPE = 47 , QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT = 48 ,   QCBOR_ERR_BAD_TAG_CONTENT = 48 , QCBOR_ERR_BAD_OPT_TAG = 48 , QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED = 49 , QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED = 50 ,   QCBOR_ERR_TAGS_DISABLED = 51 , QCBOR_ERR_PREFERRED_CONFORMANCE = 52 , QCBOR_ERR_CDE_CONFORMANCE = 53 , QCBOR_ERR_DCBOR_CONFORMANCE = 54 ,   QCBOR_ERR_UNSORTED = 55 , QCBOR_ERR_CANT_CHECK_FLOAT_CONFORMANCE = 56 , QCBOR_ERR_TOO_MANY_TAGS = 60 , QCBOR_ERR_UNEXPECTED_TYPE = 61 ,   QCBOR_ERR_DUPLICATE_LABEL = 62 , QCBOR_ERR_MEM_POOL_SIZE = 63 , QCBOR_ERR_INT_OVERFLOW = 64 , QCBOR_ERR_DATE_OVERFLOW = 65 ,   QCBOR_ERR_EXIT_MISMATCH = 66 , QCBOR_ERR_NO_MORE_ITEMS = 67 , QCBOR_ERR_LABEL_NOT_FOUND = 68 , QCBOR_ERR_NUMBER_SIGN_CONVERSION = 69 ,   QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW = 70 , QCBOR_ERR_MAP_NOT_ENTERED = 71 , QCBOR_ERR_CALLBACK_FAIL = 72 , QCBOR_ERR_FLOAT_DATE_DISABLED = 73 ,   QCBOR_ERR_HALF_PRECISION_DISABLED = 74 , QCBOR_ERR_HW_FLOAT_DISABLED = 75 , QCBOR_ERR_FLOAT_EXCEPTION = 76 , QCBOR_ERR_ALL_FLOAT_DISABLED = 77 ,   QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT = 78 , QCBOR_ERR_NOT_PREFERRED = 79 , QCBOR_ERR_NOT_ALLOWED = 80 , QCBOR_ERR_CANNOT_ENTER_ALLOCATED_STRING = 81 ,   QCBOR_ERR_NO_NEGATIVE_ZERO = 87 , QCBOR_ERR_UNEXPECTED_TAG_NUMBER = 89 , QCBOR_ERR_UNPROCESSED_TAG_NUMBER = 90 , QCBOR_ERR_FIRST_USER_DEFINED = 128 ,   QCBOR_ERR_LAST_USER_DEFINED = 255 }

Functions
const char *	qcbor_err_to_str (QCBORError uErr)
	Get string describing an error code.

Detailed Description

qcbor_common.h contains error codes and constant values that are common between encoding and decoding.

Macro Definition Documentation

CBOR_TAG_ANY

#define CBOR_TAG_ANY   (CBOR_TAG_INVALID64 - 1)

Allows tag content handler installed by QCBORDecode_InstallTagDecoders to match any tag number

CBOR_TAG_B64

#define CBOR_TAG_B64   34

See QCBOREncode_AddB64Text().

CBOR_TAG_B64URL

#define CBOR_TAG_B64URL   33

See QCBOREncode_AddTB64URLText().

CBOR_TAG_BIGFLOAT

#define CBOR_TAG_BIGFLOAT   5

CBOR tag for a two-element array representing a fraction with a mantissa and base-2 scaling factor. See QCBOREncode_AddTBigFloat() and expAndMantissa.

CBOR_TAG_BIN_UUID

#define CBOR_TAG_BIN_UUID   37

See QCBOREncode_AddTBinaryUUID().

CBOR_TAG_BINARY_MIME

#define CBOR_TAG_BINARY_MIME   257

Binary MIME.

CBOR_TAG_CBOR

#define CBOR_TAG_CBOR   24

See QCBORDecode_EnterBstrWrapped()).

CBOR_TAG_CBOR_MAGIC

#define CBOR_TAG_CBOR_MAGIC   55799

The magic number, self-described CBOR. No API is provided for this tag.

CBOR_TAG_CBOR_SEQUENCE

#define CBOR_TAG_CBOR_SEQUENCE   63

Tag for COSE format encryption. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_ENCRYPT

#define CBOR_TAG_COSE_ENCRYPT   96

Not Decoded by QCBOR. Tag for COSE format encrypt. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_ENCRYPT0

#define CBOR_TAG_COSE_ENCRYPT0   16

Not Decoded by QCBOR. Tag for COSE format encryption with no recipient identification. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_MAC

#define CBOR_TAG_COSE_MAC   97

Not Decoded by QCBOR. Tag for COSE format MAC. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_MAC0

#define CBOR_TAG_COSE_MAC0   17

Not Decoded by QCBOR. Tag for COSE format MAC'd data with no recipient identification. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_SIGN

#define CBOR_TAG_COSE_SIGN   98

Not Decoded by QCBOR. Tag for COSE format signed data. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html). No API is provided for this tag.

CBOR_TAG_COSE_SIGN1

#define CBOR_TAG_COSE_SIGN1   18

Tag for COSE format single signature signing. No API is provided for this tag. See [RFC 9052, COSE] (https://www.rfc-editor.org/rfc/rfc9052.html).

CBOR_TAG_CWT

#define CBOR_TAG_CWT   61

The data is a CBOR Web Token per [RFC 8392] (https://www.rfc-editor.org/rfc/rfc8392.html). No API is provided for this tag.

CBOR_TAG_DATE_EPOCH

#define CBOR_TAG_DATE_EPOCH   1

See QCBOREncode_AddTDateEpoch().

CBOR_TAG_DATE_STRING

#define CBOR_TAG_DATE_STRING   0

See QCBOREncode_AddTDateString().

CBOR_TAG_DAYS_EPOCH

#define CBOR_TAG_DAYS_EPOCH   100

Tag for date counted by days from Jan 1 1970 per [RFC 8943] (https://www.rfc-editor.org/rfc/rfc8943.html). See QCBOREncode_AddTDaysEpoch().

CBOR_TAG_DAYS_STRING

#define CBOR_TAG_DAYS_STRING   1004

Tag for date string without time or time zone per [RFC 8943] (https://www.rfc-editor.org/rfc/rfc8943.html). See QCBOREncode_AddTDaysString().

CBOR_TAG_DECIMAL_FRACTION

#define CBOR_TAG_DECIMAL_FRACTION   4

CBOR tag for a two-element array representing a fraction with a mantissa and base-10 scaling factor. See QCBOREncode_AddTDecimalFraction() and expAndMantissa.

CBOR_TAG_ENC_AS_B16

#define CBOR_TAG_ENC_AS_B16   23

A hint that the following byte string should be encoded in base-16 format per [RFC 4648] (https://www.rfc-editor.org/rfc/rfc4648.html) when converting to JSON or similar text-based representations. Essentially, Base-16 encoding is the standard case- insensitive hex encoding and may be referred to as "hex". Call QCBOREncode_AddTagNumber(pCtx,CBOR_TAG_ENC_AS_B16) before the call to QCBOREncode_AddBytes().

CBOR_TAG_ENC_AS_B64

#define CBOR_TAG_ENC_AS_B64   22

A hint that the following byte string should be encoded in Base64 when converting to JSON or similar text-based representations. Call QCBOREncode_AddTagNumber(pCtx,CBOR_TAG_ENC_AS_B64) before the call to QCBOREncode_AddBytes().

CBOR_TAG_ENC_AS_B64URL

#define CBOR_TAG_ENC_AS_B64URL   21

A hint that the following byte string should be encoded in Base64URL when converting to JSON or similar text-based representations. Call QCBOREncode_AddTagNumber(pCtx,CBOR_TAG_ENC_AS_B64URL) before the call to QCBOREncode_AddBytes().

CBOR_TAG_GEO_COORD

#define CBOR_TAG_GEO_COORD   103

Not Decoded by QCBOR. World geographic coordinates. See ISO 6709, [RFC 5870] (https://www.rfc-editor.org/rfc/rfc5870.html) and WGS-84. No API is provided for this tag.

CBOR_TAG_INVALID16

#define CBOR_TAG_INVALID16   0xffff

The 16-bit invalid tag from the CBOR tags registry

CBOR_TAG_INVALID32

#define CBOR_TAG_INVALID32   0xffffffff

The 32-bit invalid tag from the CBOR tags registry

CBOR_TAG_INVALID64

#define CBOR_TAG_INVALID64   0xffffffffffffffff

The 64-bit invalid tag from the CBOR tags registry

CBOR_TAG_MIME

#define CBOR_TAG_MIME   36

See QCBOREncode_AddMIMEData().

CBOR_TAG_NEG_BIGNUM

#define CBOR_TAG_NEG_BIGNUM   3

A negative big number. See QCBOREncode_AddTBigNumber(), QCBORDecode_GetTBigNumber() and QCBORDecode_StringsTagCB().

CBOR_TAG_POS_BIGNUM

#define CBOR_TAG_POS_BIGNUM   2

A postive big number. See QCBOREncode_AddTBigNumber(), QCBORDecode_GetTBigNumber() and QCBORDecode_StringsTagCB().

CBOR_TAG_REGEX

#define CBOR_TAG_REGEX   35

See QCBOREncode_AddTRegex().

CBOR_TAG_URI

#define CBOR_TAG_URI   32

See QCBOREncode_AddTURI().

QCBOR_MAX_ARRAY_NESTING

#define QCBOR_MAX_ARRAY_NESTING   15

The maximum nesting of arrays and maps when encoding or decoding. The error QCBOR_ERR_ARRAY_NESTING_TOO_DEEP will be returned on encoding or QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP on decoding if it is exceeded. Do not increase this over 255.

QCBOR_MAX_ITEMS_IN_ARRAY

#define QCBOR_MAX_ITEMS_IN_ARRAY

Value:

                                                 (UINT16_MAX-1) /* -1 is because the
                                                 * value UINT16_MAX is
                                                 * used to indicate
                                                 * indefinite-length.
                                                 */

The maximum number of items in a single array when encoding or decoding. See also QCBOR_MAX_ITEMS_IN_MAP.

QCBOR_MAX_ITEMS_IN_MAP

#define QCBOR_MAX_ITEMS_IN_MAP   (QCBOR_MAX_ITEMS_IN_ARRAY/2)

The maximum number of items in a single map when encoding or decoding. See also QCBOR_MAX_ITEMS_IN_ARRAY.

QCBOR_SPIFFY_DECODE

#define QCBOR_SPIFFY_DECODE

This define indicates a version of QCBOR that supports spiffy decode, the decode functions found in qcbor_spiffy_decode.h.

Versions of QCBOR that support spiffy decode are backwards compatible with previous versions, but there are a few minor exceptions such as some aspects of tag handling that are different. This define can be used to handle these variances.

QCBOR_VERSION_MAJOR

#define QCBOR_VERSION_MAJOR   2

Semantic versioning for QCBOR x.y.z from 1.3.0 on

Note:

• QCBOR 1.2 is indicated by the #define QCBOR_1_2
• QCBOR 1.1 is indicated by the #define QCBOR_1_1
• QCBOR 1.0 is indicated by the absence of all the above

Enumeration Type Documentation

QCBORError

enum QCBORError

Error codes returned by QCBOR Encoder-Decoder.

They are grouped to keep the code size of QCBORDecode_IsNotWellFormedError() and QCBORDecode_IsUnrecoverableError() minimal.

1..19: Encode errors 20..: Decode errors 20-39: QCBORDecode_IsNotWellFormedError() 30..59: QCBORDecode_IsUnrecoverableError() 60..: Other decode errors

Error renumbering may occur in the future when new error codes are added for new QCBOR features.

Enumerator
QCBOR_SUCCESS	The encode or decode completed correctly.
QCBOR_ERR_BUFFER_TOO_SMALL	The buffer provided for the encoded output when doing encoding was too small and the encoded output will not fit.
QCBOR_ERR_ENCODE_UNSUPPORTED	During encoding, an attempt to create simple value between 24 and 31.
QCBOR_ERR_BUFFER_TOO_LARGE	During encoding, the length of the encoded CBOR exceeded QCBOR_MAX_ARRAY_OFFSET, which is slightly less than UINT32_MAX.
QCBOR_ERR_ARRAY_NESTING_TOO_DEEP	During encoding, the array or map nesting was deeper than this implementation can handle. Note that in the interest of code size and memory use, QCBOR has a hard limit on array nesting. The limit is defined as the constant QCBOR_MAX_ARRAY_NESTING.
QCBOR_ERR_CLOSE_MISMATCH	During encoding, QCBOREncode_CloseXxx() called for a different type than is currently open.
QCBOR_ERR_ARRAY_TOO_LONG	During encoding, the array or map had too many items in it. The limits are QCBOR_MAX_ITEMS_IN_ARRAY and QCBOR_MAX_ITEMS_IN_MAP.
QCBOR_ERR_TOO_MANY_CLOSES	During encoding, more arrays or maps were closed than opened. This is a coding error on the part of the caller of the encoder.
QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN	During encoding, the number of array or map opens was not matched by the number of closes. Also occurs with opened byte strings that are not closed.
QCBOR_ERR_OPEN_BYTE_STRING	During encoding, opening a byte string while a byte string is open is not allowed.
QCBOR_ERR_CANNOT_CANCEL	Trying to cancel a byte string wrapping after items have been added to it.
QCBOR_ERR_BAD_TYPE_7	During decoding, the CBOR is not well-formed because a simple value between 0 and 31 is encoded in a two-byte integer rather than one.
QCBOR_ERR_EXTRA_BYTES	During decoding, returned by QCBORDecode_Finish() if all the inputs bytes have not been consumed. This is considered not well-formed.
QCBOR_ERR_UNSUPPORTED	During decoding, some CBOR construct was encountered that this decoder doesn't support, primarily this is the reserved additional info values, 28 through 30. The CBOR is not well-formed.
QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED	During decoding, the an array or map was not fully consumed. Returned by QCBORDecode_Finish(). The CBOR is not well-formed.
QCBOR_ERR_BAD_INT	During decoding, an integer type is encoded with a bad length (that of an indefinite length string). The CBOR is not-well formed.
QCBOR_ERR_INDEFINITE_STRING_CHUNK	During decoding, one of the chunks in an indefinite-length string is not of the type of the start of the string. The CBOR is not well-formed. This error makes no further decoding possible.
QCBOR_ERR_HIT_END	During decoding, hit the end of the given data to decode. For example, a byte string of 100 bytes was expected, but the end of the input was hit before finding those 100 bytes. Corrupted CBOR input will often result in this error. See also QCBOR_ERR_NO_MORE_ITEMS. The CBOR is not well-formed. This error makes no further decoding possible.
QCBOR_ERR_BAD_BREAK	During decoding, a break occurred outside an indefinite-length item. The CBOR is not well-formed. This error makes no further decoding possible.
QCBOR_ERR_INPUT_TOO_LARGE	During decoding, the input is too large. It is greater than QCBOR_MAX_DECODE_INPUT_SIZE. This is an implementation limit. This error makes no further decoding possible.
QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP	During decoding, the array or map nesting was deeper than this implementation can handle. Note that in the interest of code size and memory use, QCBOR has a hard limit on array nesting. The limit is defined as the constant QCBOR_MAX_ARRAY_NESTING. This error makes no further decoding possible.
QCBOR_ERR_ARRAY_DECODE_TOO_LONG	During decoding, the array or map had too many items in it. This limit is QCBOR_MAX_ITEMS_IN_ARRAY (65,534) for arrays and QCBOR_MAX_ITEMS_IN_MAP (32,767) for maps. This error makes no further decoding possible.
QCBOR_ERR_STRING_TOO_LONG	When decoding, a string's size is greater than what a size_t can hold less 4. In all but some very strange situations this is because of corrupt input CBOR and should be treated as such. The strange situation is a CPU with a very small size_t (e.g., a 16-bit CPU) and a large string (e.g., > 65KB). This error makes no further decoding possible.
QCBOR_ERR_BAD_EXP_AND_MANTISSA	Something is wrong with a decimal fraction or bigfloat such as it not consisting of an array with two integers. This error makes no further decoding possible.
QCBOR_ERR_NO_STRING_ALLOCATOR	Unable to decode an indefinite-length string because no string allocator was configured. See QCBORDecode_SetMemPool() or QCBORDecode_SetUpAllocator(). This error makes no further decoding possible.
QCBOR_ERR_STRING_ALLOCATE	Error allocating memory for a string, usually out of memory. This primarily occurs decoding indefinite-length strings. This error makes no further decoding possible.
QCBOR_ERR_MAP_LABEL_TYPE	During decoding, the type of the label for a map entry is not one that can be handled in the current decoding mode. Typically this is because a label is not an integer or a string. This is an implementation limit.
QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT	When the built-in tag decoding encounters an unexpected type, this error is returned. This error is unrecoverable because the built-in tag decoding doesn't try to consume the unexpected type. In previous versions of QCBOR this was considered a recoverable error hence QCBOR_ERR_BAD_TAG_CONTENT. Going back further, RFC 7049 use the name "optional tags". That name is no longer used because "optional" was causing confusion. See also QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT.
QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED	Indefinite length string handling is disabled and there is an indefinite length string in the input CBOR.
QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED	Indefinite length arrays and maps handling are disabled and there is an indefinite length map or array in the input CBOR.
QCBOR_ERR_TAGS_DISABLED	All decoding of tags (major type 6) has been disabled and a tag occurred in the decode input.
QCBOR_ERR_PREFERRED_CONFORMANCE	Decoded CBOR is does not conform to preferred serialization. The CBOR head's argument is not encoded in shortest form, or indefinite lengths are used.
QCBOR_ERR_CDE_CONFORMANCE	Decoded CBOR does not conform to CDE. This occurs when a map is not sorted. Other CDE issues are reported as QCBOR_ERR_PREFERRED_CONFORMANCE.
QCBOR_ERR_DCBOR_CONFORMANCE	Decoded CBOR does not conform to dCBOR. Floating point numbers are not reduced to integers. Other issues are reported as either QCBOR_ERR_CDE_CONFORMANCE or QCBOR_ERR_PREFERRED_CONFORMANCE.
QCBOR_ERR_UNSORTED	A map is unsorted and should be for CDE or dCBOR.
QCBOR_ERR_CANT_CHECK_FLOAT_CONFORMANCE	Conformance checking requested, preferred serialization disabled, float in the input.
QCBOR_ERR_TOO_MANY_TAGS	More than QCBOR_MAX_TAGS_PER_ITEM tags encountered for a CBOR Item. QCBOR_MAX_TAGS_PER_ITEM is a limit of this implementation. x
QCBOR_ERR_UNEXPECTED_TYPE	When decoding for a specific type, the type was not expected.
QCBOR_ERR_DUPLICATE_LABEL	Duplicate label detected in a map.
QCBOR_ERR_MEM_POOL_SIZE	During decoding, the buffer given to QCBORDecode_SetMemPool() is either too small, smaller than QCBOR_DECODE_MIN_MEM_POOL_SIZE or too large, larger than UINT32_MAX.
QCBOR_ERR_INT_OVERFLOW	During decoding, an integer smaller than INT64_MIN was received (CBOR can represent integers smaller than INT64_MIN, but C cannot).
QCBOR_ERR_DATE_OVERFLOW	During decoding, a date greater than +- 292 billion years from Jan 1 1970 encountered during parsing. This is an implementation limit.
QCBOR_ERR_EXIT_MISMATCH	During decoding, QCBORDecode_ExitXxx() was called for a different type than QCBORDecode_EnterXxx().
QCBOR_ERR_NO_MORE_ITEMS	All well-formed data items have been consumed and there are no more. If parsing a CBOR stream this indicates the non-error end of the stream. If not parsing a CBOR stream/sequence, this probably indicates that some data items expected are not present. See also QCBOR_ERR_HIT_END.
QCBOR_ERR_LABEL_NOT_FOUND	When finding an item by label, an item with the requested label was not found.
QCBOR_ERR_NUMBER_SIGN_CONVERSION	Number conversion failed because of sign. For example a negative int64_t can't be converted to a uint64_t
QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW	When converting a decoded number, the value is too large or too small for the conversion target.
QCBOR_ERR_MAP_NOT_ENTERED	Trying to get an item by label when a map has not been entered.
QCBOR_ERR_CALLBACK_FAIL	A callback indicates processing should not continue for some non-CBOR reason.
QCBOR_ERR_FLOAT_DATE_DISABLED	This error code is deprecated. Instead, QCBOR_ERR_HALF_PRECISION_DISABLED, QCBOR_ERR_HW_FLOAT_DISABLED or QCBOR_ERR_ALL_FLOAT_DISABLED is returned depending on the specific floating-point functionality that is disabled and the type of floating-point input.
QCBOR_ERR_HALF_PRECISION_DISABLED	Support for half-precision float decoding is disabled.
QCBOR_ERR_HW_FLOAT_DISABLED	Use of floating-point HW is disabled. This affects all type conversions to and from double and float types.
QCBOR_ERR_FLOAT_EXCEPTION	Unable to complete operation because a floating-point value that is a NaN (not a number), that is too large, too small, infinity or -infinity was encountered in encoded CBOR. Usually this because conversion of the float-point value was being attempted.
QCBOR_ERR_ALL_FLOAT_DISABLED	Floating point support is completely turned off, encoding/decoding floating point numbers is not possible.
QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT	Like QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT, but recoverable. If an implementation decodes a tag and can and does consume the whole tag contents when it is not the correct tag content, this error can be returned. None of the built-in tag decoders do this (to save object code).
QCBOR_ERR_NOT_PREFERRED	Attempt to output non-preferred, non-CDE or non-dCBOR when not allowed by mode. See QCBOREncode_SerializationPreferred(), QCBOREncode_SerializationCDE(), QCBOREncode_SerializationdCBOR() and QCBOR_ENCODE_CONFIG_DISALLOW_NON_PREFERRED_NUMBERS.
QCBOR_ERR_NOT_ALLOWED	Trying to do something that is not allowed.
QCBOR_ERR_CANNOT_ENTER_ALLOCATED_STRING	QCBORDecode_EnterBstrWrapped() cannot be used on indefinite-length strings because they exist in the memory pool for a QCBORStringAllocate.
QCBOR_ERR_NO_NEGATIVE_ZERO	Can't output a negative zero big num
QCBOR_ERR_UNEXPECTED_TAG_NUMBER	An unconsumed tag number was encountered.
QCBOR_ERR_UNPROCESSED_TAG_NUMBER	In QCBOR v2, tag numbers must be processed by QCBORDecode_GetNextTagNumber(). See QCBOR_DECODE_ALLOW_UNPROCESSED_TAG_NUMBERS.
QCBOR_ERR_FIRST_USER_DEFINED	A range of error codes that can be made use of by the caller. QCBOR internally does nothing with these except notice that they are not QCBOR_SUCCESS. See QCBORDecode_SetError().
QCBOR_ERR_LAST_USER_DEFINED	See QCBOR_ERR_FIRST_USER_DEFINED

Function Documentation

qcbor_err_to_str()

const char * qcbor_err_to_str

(

QCBORError

uErr

)

Get string describing an error code.

Parameters

[in]

uErr

The error code.

Returns

NULL-terminated string describing error or "Unidentified error" if the error is not known.

This is not thread-safe because it uses a static buffer for formatting, but this is only a diagnostic and the only consequence is the wrong description.