Struct ffizz_string::fz_string_t
source · #[repr(C)]pub struct fz_string_t { /* private fields */ }
Expand description
fz_string_t represents a string suitable for use with this crate, as an opaque stack-allocated value.
This value can contain either a string or a special “Null” variant indicating there is no
string. When functions take a fz_string_t*
as an argument, the NULL pointer is treated as
the Null variant. Note that the Null variant is not necessarily represented as the zero value
of the struct.
Safety
A fz_string_t must always be initialized before it is passed as an argument. Functions
returning a fz_string_t
return an initialized value.
Each initialized fz_string_t must be freed, either by calling fz_string_free or by passing the string to a function which takes ownership of the string.
For a given fz_string_t value, API functions must not be called concurrently. This includes “read only” functions such as fz_string_content.
typedef struct fz_string_t {
uint64_t __reserved[4]
}