Codex module

make_help

procedureSource

Checks the bytes of a .codex file and indexes its records. Returns false with a reason when the file is truncated or of another version. The result points into memory; release it with deinit.

Example↗
memory := cast([] u8) "not a codex file";
ok, help, error := make_help(memory);
assert(!ok && error.count > 0);
make_help :: (
    memory: [] u8
) -> (success: bool, help: Codex_Help, error_string: string)

Parameters

memory: [] u8

Returns

success: bool
error_string: string

See also