Type 3 – UTF-8 strings¶

CBOR strings have the same structure as Type 2 – Byte strings.

Corresponding `cbor_type`	`CBOR_TYPE_STRING`
Number of allocations (definite)	One plus any manipulations with the data
Number of allocations (indefinite)	One plus logarithmically many reallocations relative to chunk count
Storage requirements (definite)	`sizeof(cbor_item_t) + length(handle)`
Storage requirements (indefinite)	`sizeof(cbor_item_t) * (1 + chunk_count) + chunks`

UTF-8 encoding validation¶

libcbor considers UTF-8 encoding validity to be a part of the well-formedness notion of CBOR and therefore invalid UTF-8 strings will be rejected by the parser. Strings created by the user are not checked.

Getting metadata¶

size_t cbor_string_length(const cbor_item_t *item)¶

Returns the length of the underlying string in bytes.

There can be fewer unicode character than bytes (see cbor_string_codepoint_count). For definite strings only.

param item: a definite string
return: length of the string. Zero if no chunk has been attached yet

bool cbor_string_is_definite(const cbor_item_t *item)¶

Is the string definite?

param item: a string
return: Is the string definite?

bool cbor_string_is_indefinite(const cbor_item_t *item)¶

Is the string indefinite?

param item: a string
return: Is the string indefinite?

size_t cbor_string_chunk_count(const cbor_item_t *item)¶

Get the number of chunks this string consist of.

param item: A indefinite string
return: The chunk count. 0 for freshly created items.

Reading data¶

cbor_mutable_data cbor_string_handle(const cbor_item_t *item)¶

Get the handle to the underlying string.

Definite items only. Modifying the data is allowed. In that case, the caller takes responsibility for the effect on items this item might be a part of

param item: A definite string
return: The address of the underlying string.
return: NULL if no data have been assigned yet.

cbor_item_t **cbor_string_chunks_handle(const cbor_item_t *item)¶

Get the handle to the array of chunks.

Manipulations with the memory block (e.g. sorting it) are allowed, but the validity and the number of chunks must be retained.

param item: A indefinite string
return: array of cbor_string_chunk_count definite strings

Creating new items¶

cbor_item_t *cbor_new_definite_string(void)¶

Creates a new definite string.

The handle is initialized to NULL and length to 0

return: Reference to the new string item. The item’s reference count is initialized to one.
return: NULL if memory allocation fails

cbor_item_t *cbor_new_indefinite_string(void)¶

Creates a new indefinite string.

The chunks array is initialized to NULL and chunkcount to 0

return: Reference to the new string item. The item’s reference count is initialized to one.
return: NULL if memory allocation fails

Building items¶

cbor_item_t *cbor_build_string(const char *val)¶

Creates a new string and initializes it.

The data from val will be copied to a newly allocated memory block.

Note that valid UTF-8 strings do not contain null bytes, so this routine is correct for all valid inputs. If the input is not guaranteed to be valid, use cbor_build_stringn instead.

param val: A null-terminated UTF-8 string
return: Reference to the new string item. The item’s reference count is initialized to one.
return: NULL if memory allocation fails

Manipulating existing items¶

void cbor_string_set_handle(cbor_item_t *item, cbor_mutable_data data, size_t length)¶

Set the handle to the underlying string.

The data is assumed to be a valid UTF-8 string. If the string is non-empty and invalid, cbor_string_codepoint_count will return 0.

Warning

Using a pointer to a stack allocated constant is a common mistake. Lifetime of the string will expire when it goes out of scope and the CBOR item will be left inconsistent.

param item: A definite string
param data: The memory block. The caller gives up the ownership of the block. libcbor will deallocate it when appropriate using its free function
param length: Length of the data block

bool cbor_string_add_chunk(cbor_item_t *item, cbor_item_t *chunk)¶

Appends a chunk to the string.

Indefinite strings only.

May realloc the chunk storage.

param item: An indefinite string
param chunk: A definite string item. Its reference count will be increased by one.
return: true on success. false on memory allocation failure. In that case, the refcount of is not increased and the is left intact.