arf-strings 0.1.1

Encoding and decoding for ARF strings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

#ifndef ARF_H
#define ARF_H

#include <stddef.h>
#include <stdint.h>
#ifndef __cplusplus
#include <stdbool.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/// Test whether the provided C-string is already valid UTF-8.
bool arf_is_valid_cstr(const char *cstr)
    __attribute__((__pure__, __nonnull__(1), __nothrow__));

/// Quickly test whether the provided buffer looks like an ARF string.
bool arf_has_arf_magic(const uint8_t *ptr, size_t len)
    __attribute__((__pure__, __nothrow__));

/// Test whether the provided buffer is a valid ARF string.
bool arf_is_valid_arf(const uint8_t *ptr, size_t len)
    __attribute__((__pure__, __nothrow__));

/// Test whether the provided C-string is already valid UTF-8. If it is, store
/// the length in *len and return true. If it isn't, store the length of the ARF
/// string needed to represent it in *len and return false.
bool arf_categorize_cstr(const char *cstr, size_t *__restrict__ len)
    __attribute__((__nonnull__(1, 2), __nothrow__));

/// Return the length of an ARF string for the given C-string. Returns
/// `SIZE_MAX` on overflow.
size_t arf_sizeof_cstr_arf(const char *cstr)
    __attribute__((__pure__, __nonnull__(1), __nothrow__));

/// Write the ARF string for the given C-string into the provided buffer. Use
/// `arf_sizeof_cstr_arf` to determine the required buffer size.
void arf_cstr_arf(const char *cstr, uint8_t *__restrict__ ptr)
    __attribute__((__nonnull__(1, 2), __nothrow__));

/// Return the length of a C-string for the given ARF.
size_t arf_sizeof_arf_cstr(const uint8_t *ptr, size_t len)
    __attribute__((__pure__, __nonnull__(1), __nothrow__));

/// Write the C-string for the given ARF into the provided buffer. Use
/// `arf_sizeof_arf_cstr` to determine the required buffer size.
void arf_arf_cstr(const uint8_t *ptr, size_t len, char *__restrict__ cstr)
    __attribute__((__nonnull__(1, 3), __nothrow__));

#ifdef __cplusplus
}
#endif

#endif