libcbor  0.5.0
libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.
strings.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2017 Pavel Kalvoda <me@pavelkalvoda.com>
3  *
4  * libcbor is free software; you can redistribute it and/or modify
5  * it under the terms of the MIT license. See LICENSE for details.
6  */
7 
8 #ifndef LIBCBOR_STRINGS_H
9 #define LIBCBOR_STRINGS_H
10 
11 #include "cbor/common.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 /*
18 * ============================================================================
19 * String manipulation
20 * ============================================================================
21 */
22 
30 size_t cbor_string_length(const cbor_item_t *item);
31 
39 size_t cbor_string_codepoint_count(const cbor_item_t *item);
40 
46 bool cbor_string_is_definite(const cbor_item_t *item);
47 
53 bool cbor_string_is_indefinite(const cbor_item_t *item);
54 
64 
77 
86 
92 size_t cbor_string_chunk_count(const cbor_item_t *item);
93 
104 bool cbor_string_add_chunk(cbor_item_t *item, cbor_item_t *chunk);
105 
113 
121 
129 cbor_item_t *cbor_build_string(const char *val);
130 
138 cbor_item_t *cbor_build_stringn(const char *val, size_t length);
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif //LIBCBOR_STRINGS_H
cbor_item_t * cbor_new_definite_string()
Creates a new definite string.
Definition: strings.c:12
cbor_mutable_data cbor_string_handle(const cbor_item_t *item)
Get the handle to the underlying string.
Definition: strings.c:112
bool cbor_string_is_indefinite(const cbor_item_t *item)
Is the string indefinite?
Definition: strings.c:130
#define CBOR_RESTRICT_POINTER
Definition: common.h:33
void cbor_string_set_handle(cbor_item_t *item, cbor_mutable_data CBOR_RESTRICT_POINTER data, size_t length)
Set the handle to the underlying string.
Definition: strings.c:59
cbor_item_t * cbor_build_stringn(const char *val, size_t length)
Creates a new string and initializes it.
Definition: strings.c:50
cbor_item_t * cbor_build_string(const char *val)
Creates a new string and initializes it.
Definition: strings.c:40
unsigned char * cbor_mutable_data
Definition: data.h:21
bool cbor_string_is_definite(const cbor_item_t *item)
Is the string definite?
Definition: strings.c:124
size_t cbor_string_length(const cbor_item_t *item)
Returns the length of the underlying string.
Definition: strings.c:106
bool cbor_string_add_chunk(cbor_item_t *item, cbor_item_t *chunk)
Appends a chunk to the string.
Definition: strings.c:82
cbor_item_t ** cbor_string_chunks_handle(const cbor_item_t *item)
Get the handle to the array of chunks.
Definition: strings.c:67
size_t cbor_string_chunk_count(const cbor_item_t *item)
Get the number of chunks this string consist of.
Definition: strings.c:74
size_t cbor_string_codepoint_count(const cbor_item_t *item)
The number of codepoints in this string.
Definition: strings.c:118
The item handle.
Definition: data.h:149
cbor_item_t * cbor_new_indefinite_string()
Creates a new indefinite string.
Definition: strings.c:23