diff options
Diffstat (limited to 'docs/cstr_api.md')
| -rw-r--r-- | docs/cstr_api.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/cstr_api.md b/docs/cstr_api.md index 30bff0c7..b6a516a6 100644 --- a/docs/cstr_api.md +++ b/docs/cstr_api.md @@ -4,17 +4,20 @@ This describes the API of string type **cstr_t**. ## Types -| cstr | Type definition | Used to represent... | +| Type name | Type definition | Used to represent... | |:------------------|:---------------------------------------|:-------------------------------------| | `cstr_t` | `struct { const char *str; }` | The string type | | `cstr_value_t` | `char` | The string element type | -| `cstr_iter_t` | `struct { char *val; }` | String iterator | +| `cstr_iter_t` | `struct { cstr_value_t *val; }` | cstr_t iterator | -## Constants +## Constants and macros -| cstr constant name | Numerical values | +| Name | Value / Returns | |:---------------------------|:-----------------| | `cstr_npos` | `-1ULL` | +| `cstr_size(str) | | +| `cstr_capacity(str) | | +| `cstr_empty(str) | | ## Header file |