Expand description
Modules§
- code
- This module contains the
Codedata structure and its iterators. - compiler
- The compiler is the last step of the compilation process which translates an AST to Lua code.
- env
- The
envmodule contains miscellaneous structs and enums related to the compiler options available - parser
- The parser is the third step of the compilation process. It takes the tokens from the scanner and converts them into an AST (Abstract Syntax Tree).
- preprocessor
- The preprocessor is the first step in the compilation process. It is responsible for removing comments and expanding macros and directives.
- scanner
- The scanner is the second step of the compilation process, it takes the preprocessed source code and turns it into a list of tokens
Macros§
- check
- Check whether
tocheckisOkorErrIf it’sOkit returns it If it’sErrit converts the error to aStringand propagates it to the caller function - format_
clue - Format strings, used mainly inside the Clue code base
This is used to format strings in a way that is more efficient than using
format!
Structs§
- Clue
- The main Clue library API This is the API that you will use to interact with Clue for most use cases It’s recommended to use this API instead of the lower level APIs unless you need to