qcbor_tag_encode.h File Reference

#include "qcbor/qcbor_common.h"
#include "qcbor/qcbor_private.h"
#include "qcbor/qcbor_main_encode.h"
#include <stdbool.h>

Go to the source code of this file.

Enumerations
enum	QCBOREncodeTagReq { QCBOR_ENCODE_AS_TAG = 0 , QCBOR_ENCODE_AS_BORROWED = 1 }

Functions
static void	QCBOREncode_AddTagNumber (QCBOREncodeContext *pCtx, uint64_t uTagNumber)
	Add a tag number.
static void	QCBOREncode_AddTDateEpoch (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate)
	Add an epoch-based date.
static void	QCBOREncode_AddTDateEpochToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate)
static void	QCBOREncode_AddTDateEpochToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate)
static void	QCBOREncode_AddTDaysEpoch (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays)
	Add an epoch-based day-count date.
static void	QCBOREncode_AddTDaysEpochToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays)
static void	QCBOREncode_AddTDaysEpochToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays)
static void	QCBOREncode_AddTBinaryUUID (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID)
	Add a binary UUID to the encoded output.
static void	QCBOREncode_AddTBinaryUUIDToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID)
static void	QCBOREncode_AddTBinaryUUIDToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID)
static void	QCBOREncode_AddTURI (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI)
	Add a text URI to the encoded output.
static void	QCBOREncode_AddTURIToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI)
static void	QCBOREncode_AddTURIToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI)
static void	QCBOREncode_AddTB64Text (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
	Add Base64-encoded text to encoded output.
static void	QCBOREncode_AddTB64TextToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
static void	QCBOREncode_AddTB64TextToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
static void	QCBOREncode_AddTB64URLText (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
	Add base64url encoded data to encoded output.
static void	QCBOREncode_AddTB64URLTextToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
static void	QCBOREncode_AddTB64URLTextToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text)
static void	QCBOREncode_AddTRegex (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex)
	Add Perl Compatible Regular Expression.
static void	QCBOREncode_AddTRegexToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex)
static void	QCBOREncode_AddTRegexToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex)
static void	QCBOREncode_AddTMIMEData (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData)
	MIME encoded data to the encoded output.
static void	QCBOREncode_AddTMIMEDataToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData)
static void	QCBOREncode_AddTMIMEDataToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData)
static void	QCBOREncode_AddTDateString (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
	Add an RFC 3339 date string.
static void	QCBOREncode_AddTDateStringToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
static void	QCBOREncode_AddTDateStringToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
static void	QCBOREncode_AddTDaysString (QCBOREncodeContext *pCtx, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
	Add a date-only string.
static void	QCBOREncode_AddTDaysStringToMapSZ (QCBOREncodeContext *pCtx, const char *szLabel, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
static void	QCBOREncode_AddTDaysStringToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, const char *szDate)
static void	QCBOREncode_AddDateEpoch (QCBOREncodeContext *pCtx, int64_t nDate)
static void	QCBOREncode_AddDateEpochToMap (QCBOREncodeContext *pCtx, const char *szLabel, int64_t nDate)
static void	QCBOREncode_AddDateEpochToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, int64_t nDate)
static void	QCBOREncode_AddBinaryUUID (QCBOREncodeContext *pCtx, UsefulBufC UUID)
static void	QCBOREncode_AddBinaryUUIDToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC UUID)
static void	QCBOREncode_AddBinaryUUIDToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC UUID)
static void	QCBOREncode_AddTag (QCBOREncodeContext *pCtx, uint64_t uTagNumber)
static void	QCBOREncode_AddURI (QCBOREncodeContext *pCtx, UsefulBufC URI)
static void	QCBOREncode_AddURIToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC URI)
static void	QCBOREncode_AddURIToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC URI)
static void	QCBOREncode_AddB64Text (QCBOREncodeContext *pCtx, UsefulBufC B64Text)
static void	QCBOREncode_AddB64TextToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC B64Text)
static void	QCBOREncode_AddB64TextToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC B64Text)
static void	QCBOREncode_AddB64URLText (QCBOREncodeContext *pCtx, UsefulBufC B64Text)
static void	QCBOREncode_AddB64URLTextToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC B64Text)
static void	QCBOREncode_AddB64URLTextToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC B64Text)
static void	QCBOREncode_AddRegex (QCBOREncodeContext *pCtx, UsefulBufC Regex)
static void	QCBOREncode_AddRegexToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC Regex)
static void	QCBOREncode_AddRegexToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC Regex)
static void	QCBOREncode_AddMIMEData (QCBOREncodeContext *pCtx, UsefulBufC MIMEData)
static void	QCBOREncode_AddMIMEDataToMap (QCBOREncodeContext *pCtx, const char *szLabel, UsefulBufC MIMEData)
static void	QCBOREncode_AddMIMEDataToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, UsefulBufC MIMEData)
static void	QCBOREncode_AddDateString (QCBOREncodeContext *pCtx, const char *szDate)
static void	QCBOREncode_AddDateStringToMap (QCBOREncodeContext *pCtx, const char *szLabel, const char *szDate)
static void	QCBOREncode_AddDateStringToMapN (QCBOREncodeContext *pCtx, int64_t nLabel, const char *szDate)

Detailed Description

Tag Encoding

If you are unfamiliar with CBOR tags and related terminology, reviewing the CBORTags documentation.

QCBOR provides multiple ways to encode tags, some for standard tags that QCBOR supports directly and another that works for any tag.

Encoding Standardized Tags

For many standardized tags, QCBOR offers dedicated methods. For instance, the standard tag for an epoch date can be encoded using QCBOREncode_AddTDateEpoch(). These methods are easily identifiable by their names, which always begin with "QCBOREncode_AddT".

General Tag Encoding

To encode a any tag, you can use QCBOREncode_AddTagNumber() followed by other QCBOR encode methods to encode the tag content.

• Minimal Example: For a simple tag, you might only call QCBOREncode_AddTagNumber() followed by QCBOREncode_AddInt64().
• Complex Example: For more complex structures, QCBOREncode_AddTagNumber() might precede a call to QCBOREncode_OpenMap() and the encoding of all the items in the map. Or, QCBOREncode_AddTagNumber() might precede a call to a library function that creates a complex message like a COSE_Encrypt.

Tags can nest, so there might be sequential calls to QCBOREncode_AddTagNumber(). While deep nesting is rare and there is no limit for encoding, QCBOR decoding is limited to a depth of QCBOR_MAX_TAGS_PER_ITEM.

Borrowing Tag Content

As explained in AreTagsOptional, tag content for a specific tag is often encoded without including the tag number. This practice, known as "borrowing" tag content, is comparable to implicit tagging in ASN.1, where the type is inferred from the context.

All QCBOR APIs for encoding specific tags, such as QCBOREncode_AddTDaysEpoch(), include an argument of type QCBOREncodeTagReq. This argument determines whether the tag number should be included or omitted.

For tags for which QCBOR provides no API, outputting borrowed content amounts to just omitting the tag number.

For tags without dedicated QCBOR APIs, encoding borrowed content is straightforward: simply omit the tag number.

Enumeration Type Documentation

QCBOREncodeTagReq

enum QCBOREncodeTagReq

Enum used by specific tag-encoding functions, those whose names start with "QCBOREncode_AddT", to indicates whether a tag should be encoded as a full tag or as borrowed content.

Enumerator
QCBOR_ENCODE_AS_TAG	Output the full tag including the tag number. See AreTagsOptional.
QCBOR_ENCODE_AS_BORROWED	Output only the borrowed content for the tag. No tag number is output. See AreTagsOptional.

Function Documentation

QCBOREncode_AddTagNumber()

static void QCBOREncode_AddTagNumber ( QCBOREncodeContext * pCtx, uint64_t uTagNumber )

inlinestatic

Add a tag number.

Parameters

[in]	pCtx	The encoding context to add the tag to.
[in]	uTagNumber	The tag number to add.

This outputs a CBOR major type 6 item, a tag number that indicates the next item is a different type. See TagEncoding.

For many of the common standard tags, a function to encode data using it is provided and this is not needed. For example, QCBOREncode_AddTDateEpoch() already exists to output integers representing epochs dates.

The tag number is applied to the next data item added to the encoded output. That data item that is to be tagged can be of any major CBOR type. Any number of tag numbers can be added to a data item by calling this multiple times before the data item is added.

See also TagEncoding.

QCBOREncode_AddTB64Text()

static void QCBOREncode_AddTB64Text ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

Add Base64-encoded text to encoded output.

Parameters

[in]	pCtx	The encoding context to add the base-64 text to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	B64Text	Pointer and length of the base-64 encoded text.

The text content is Base64 encoded data per RFC 4648.

It is output as CBOR major type 3, a text string, with tag CBOR_TAG_B64 indicating the text string is Base64 encoded.

QCBOREncode_AddTB64TextToMapN()

static void QCBOREncode_AddTB64TextToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

See QCBOREncode_AddTB64Text().

QCBOREncode_AddTB64TextToMapSZ()

static void QCBOREncode_AddTB64TextToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

See QCBOREncode_AddTB64Text().

QCBOREncode_AddTB64URLText()

static void QCBOREncode_AddTB64URLText ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

Add base64url encoded data to encoded output.

Parameters

[in]	pCtx	The encoding context to add the base64url to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	B64Text	Pointer and length of the base64url encoded text.

The text content is base64URL encoded text as per RFC 4648.

It is output as CBOR major type 3, a text string, with tag CBOR_TAG_B64URL indicating the text string is a Base64url encoded.

QCBOREncode_AddTB64URLTextToMapN()

static void QCBOREncode_AddTB64URLTextToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

See QCBOREncode_AddTB64URLText().

QCBOREncode_AddTB64URLTextToMapSZ()

static void QCBOREncode_AddTB64URLTextToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC B64Text )

inlinestatic

See QCBOREncode_AddTB64URLText().

QCBOREncode_AddTBinaryUUID()

static void QCBOREncode_AddTBinaryUUID ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID )

inlinestatic

Add a binary UUID to the encoded output.

Parameters

[in]	pCtx	The encoding context to add the UUID to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	UUID	Pointer and length of the binary UUID.

A binary UUID as defined in RFC 4122 is added to the output.

It is output as CBOR major type 2, a binary string, with tag CBOR_TAG_BIN_UUID indicating the binary string is a UUID.

QCBOREncode_AddTBinaryUUIDToMapN()

static void QCBOREncode_AddTBinaryUUIDToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID )

inlinestatic

See QCBOREncode_AddTBinaryUUID().

QCBOREncode_AddTBinaryUUIDToMapSZ()

static void QCBOREncode_AddTBinaryUUIDToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC UUID )

inlinestatic

See QCBOREncode_AddTBinaryUUID().

QCBOREncode_AddTDateEpoch()

static void QCBOREncode_AddTDateEpoch ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate )

inlinestatic

Add an epoch-based date.

Parameters

[in]	pCtx	The encoding context to add the date to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	nDate	Number of seconds since 1970-01-01T00:00Z in UTC time.

As per RFC 8949 this is similar to UNIX/Linux/POSIX dates. This is the most compact way to specify a date and time in CBOR. Note that this is always UTC and does not include the time zone. Use QCBOREncode_AddDateString() if you want to include the time zone.

The preferred integer serialization rules apply here so the date will be encoded in a minimal number of bytes. Until about the year 2106 these dates will encode in 6 bytes – one byte for the tag, one byte for the type and 4 bytes for the integer. After that it will encode to 10 bytes.

Negative values are supported for dates before 1970.

If you care about leap-seconds and that level of accuracy, make sure the system you are running this code on does it correctly. This code just takes the value passed in.

This implementation cannot encode fractional seconds using float or double even though that is allowed by CBOR, but you can encode them if you want to by calling QCBOREncode_AddTagNumber() and QCBOREncode_AddDouble().

Error handling is the same as QCBOREncode_AddInt64().

See also QCBOREncode_AddTDaysEpoch().

QCBOREncode_AddTDateEpochToMapN()

static void QCBOREncode_AddTDateEpochToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate )

inlinestatic

See QCBOREncode_AddTDateEpoch().

QCBOREncode_AddTDateEpochToMapSZ()

static void QCBOREncode_AddTDateEpochToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDate )

inlinestatic

See QCBOREncode_AddTDateEpoch().

QCBOREncode_AddTDateString()

static void QCBOREncode_AddTDateString ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

Add an RFC 3339 date string.

Parameters

[in]	pCtx	The encoding context to add the date to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	szDate	Null-terminated string with date to add.

The string szDate should be in the form of RFC 3339 as defined by section 3.3 in RFC 4287. This is as described in section 3.4.1 in RFC 8949.

Note that this function doesn't validate the format of the date string at all. If you add an incorrect format date string, the generated CBOR will be incorrect and the receiver may not be able to handle it.

Error handling is the same as QCBOREncode_AddInt64().

See also QCBOREncode_AddTDayString().

QCBOREncode_AddTDateStringToMapN()

static void QCBOREncode_AddTDateStringToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

See QCBOREncode_AddTDateString().

QCBOREncode_AddTDateStringToMapSZ()

static void QCBOREncode_AddTDateStringToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

See QCBOREncode_AddTDateString().

QCBOREncode_AddTDaysEpoch()

static void QCBOREncode_AddTDaysEpoch ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays )

inlinestatic

Add an epoch-based day-count date.

Parameters

[in]	pCtx	The encoding context to add the date to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	nDays	Number of days before or after 1970-01-0.

This date format is described in RFC 8943.

The preferred integer serialization rules apply here so the date will be encoded in a minimal number of bytes. Until about the year 2149 these dates will encode in 4 bytes – one byte for the tag, one byte for the type and 2 bytes for the integer.

See also QCBOREncode_AddTDateEpoch().

QCBOREncode_AddTDaysEpochToMapN()

static void QCBOREncode_AddTDaysEpochToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays )

inlinestatic

See QCBOREncode_AddTDaysEpoch().

QCBOREncode_AddTDaysEpochToMapSZ()

static void QCBOREncode_AddTDaysEpochToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, int64_t nDays )

inlinestatic

See QCBOREncode_AddTDaysEpoch().

QCBOREncode_AddTDaysString()

static void QCBOREncode_AddTDaysString ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

Add a date-only string.

Parameters

[in]	pCtx	The encoding context to add the date to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	szDate	Null-terminated string with date to add.

This date format is described in RFC 8943, but that mainly references RFC 3339. The string szDate must be in the forrm specified the ABNF for a full-date in RFC 3339. Examples of this are "1985-04-12" and "1937-01-01". The time and the time zone are never included.

Note that this function doesn't validate the format of the date string at all. If you add an incorrect format date string, the generated CBOR will be incorrect and the receiver may not be able to handle it.

Error handling is the same as QCBOREncode_AddInt64().

See also QCBOREncode_AddTDateString().

QCBOREncode_AddTDaysStringToMapN()

static void QCBOREncode_AddTDaysStringToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

See QCBOREncode_AddTDaysString().

QCBOREncode_AddTDaysStringToMapSZ()

static void QCBOREncode_AddTDaysStringToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, const char * szDate )

inlinestatic

See QCBOREncode_AddTDaysString().

QCBOREncode_AddTMIMEData()

static void QCBOREncode_AddTMIMEData ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData )

inlinestatic

MIME encoded data to the encoded output.

Parameters

[in]	pCtx	The encoding context to add the MIME data to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	MIMEData	Pointer and length of the MIME data.

The text content is in MIME format per RFC 2045 including the headers.

It is output as CBOR major type 2, a binary string, with tag CBOR_TAG_BINARY_MIME indicating the string is MIME data. This outputs tag 257, not tag 36, as it can carry any type of MIME binary, 7-bit, 8-bit, quoted-printable and base64 where tag 36 cannot.

Previous versions of QCBOR, those before spiffy decode, output tag

1. Decoding supports both tag 36 and 257. (if the old behavior with tag 36 is needed, copy the inline functions below and change the tag number).

See also QCBORDecode_GetMIMEMessage() and QCBOR_TYPE_BINARY_MIME.

This does no translation of line endings. See QCBOREncode_AddText() for a discussion of line endings in CBOR.

QCBOREncode_AddTMIMEDataToMapN()

static void QCBOREncode_AddTMIMEDataToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData )

inlinestatic

See QCBOREncode_AddTMIMEData().

QCBOREncode_AddTMIMEDataToMapSZ()

static void QCBOREncode_AddTMIMEDataToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC MIMEData )

inlinestatic

See QCBOREncode_AddTMIMEData().

QCBOREncode_AddTRegex()

static void QCBOREncode_AddTRegex ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex )

inlinestatic

Add Perl Compatible Regular Expression.

Parameters

[in]	pCtx	Encoding context to add the regular expression to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	Regex	Pointer and length of the regular expression.

The text content is Perl Compatible Regular Expressions (PCRE) / JavaScript syntax [ECMA262].

It is output as CBOR major type 3, a text string, with tag CBOR_TAG_REGEX indicating the text string is a regular expression.

QCBOREncode_AddTRegexToMapN()

static void QCBOREncode_AddTRegexToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex )

inlinestatic

See QCBOREncode_AddTRegex().

QCBOREncode_AddTRegexToMapSZ()

static void QCBOREncode_AddTRegexToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC Regex )

inlinestatic

See QCBOREncode_AddTRegex().

QCBOREncode_AddTURI()

static void QCBOREncode_AddTURI ( QCBOREncodeContext * pCtx, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI )

inlinestatic

Add a text URI to the encoded output.

Parameters

[in]	pCtx	The encoding context to add the URI to.
[in]	uTagRequirement	Either QCBOR_ENCODE_AS_TAG or QCBOR_ENCODE_AS_BORROWED.
[in]	URI	Pointer and length of the URI.

The format of URI must be per RFC 3986.

It is output as CBOR major type 3, a text string, with tag CBOR_TAG_URI indicating the text string is a URI.

A URI in a NULL-terminated string, szURI, can be easily added with this code:

 QCBOREncode_AddTURI(pCtx, QCBOR_ENCODE_AS_TAG, UsefulBuf_FromSZ(szURI));

QCBOREncode_AddTURIToMapN()

static void QCBOREncode_AddTURIToMapN ( QCBOREncodeContext * pCtx, int64_t nLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI )

inlinestatic

See QCBOREncode_AddTURI().

QCBOREncode_AddTURIToMapSZ()

static void QCBOREncode_AddTURIToMapSZ ( QCBOREncodeContext * pCtx, const char * szLabel, enum QCBOREncodeTagReq uTagRequirement, UsefulBufC URI )

inlinestatic

See QCBOREncode_AddTURI().