Types

• There are two types define in this package

  • KilnString ⇒ This is the typical heap-allocated, mutable length string. It is nullable and is guaranteed to be null terminated.

    typedef struct KilnString {
        char* ptr;
        uint64_t __length;
        uint64_t __capacity;
    } KilnString;
    

  • StringRef ⇒ This is a reference to a string or substring. It is nullable is is not guaranteed to be null terminated.

    typedef struct StringRef {
        char* ptr;
        uint64_t __length;
    } StringRef;
    

Overview

• All functions provided by this library will not do any null checks, this introduces additional (and possibly unnecessary) checks and code branches which is bad for performance.
• Many of the functions provided by this library will not return a string/reference object with a null pointer, and the functions that do will have that explicitly marked in their doxygen documentation. In the case that a string/reference object may be null, it is the library user’s job to ensure it isn’t null.