Rant is a high-level procedural templating language. It is designed to help you write more dynamic and expressive templates, dialogue, stories, names, test data, and much more.
For language documentation, see the Rant Reference.
All programs are run through a Rant context, represented by the
It allows you to execute Rant programs, define and retrieve global variables, manipulate the RNG, and compile Rant code.
You will notice that the
Err variant of the
Rant::compile* methods is
() instead of providing an error list. Instead,
errors and warnings are reported via implementors of the
Reporter trait, which allows the user to control what happens to messages emitted by the compiler.
Currently, Rant has two built-in
Reporter implementations: the unit type
You can also make your own custom reporters to suit your specific needs.
Represents an error that occurred when attempting to load a Rant module.
A Rant execution context.
Rant’s “empty” value.
A function callable from Rant.
list type, which stores an ordered, mutable collection of values.
Reference handle for a Rant list
map type, which stores a mutable collection of key-value pairs.
Map keys are always strings.
Reference handle for a Rant map
Provides options for customizing the creation of a
A compiled Rant program.
Contains metadata used to identify a loaded program.
range type, which characterizes a closed range of integers with an exclusive end bound.
tuple type, which stores an ordered, immutable collection of values.
Reference handle for a Rant tuple
Error produced by indexing a RantValue.
Error produced by keying a RantValue.
Represents the reason for which a Rant module failed to load.
Defines endpoint variants for Rant functions.
Represents a dynamically-typed Rant number.
special type, which stores internal runtime data.
A dynamically-typed Rant value.
A lightweight representation of a Rant value’s type.
Represents a Rant variable of one of two flavors: by-value or by-reference.
Error produced by slicing a RantValue.
Error produced by a RantValue operator or conversion.
The build version according to the crate metadata at the time of compiling.
The default name given to programs compiled from raw strings.
The name of the environment variable that Rant checks when checking the global modules path.
The file extension that Rant expects modules to have.
The Rant language version implemented by this library.
Trait for converting something to a Rant function.
Converts from argument list to tuple of
impl TryFromRant values
Enables fallible conversion from a
Enables fallible conversion into a
Type alias for
The result type used by Rant value index read operations.
The result type used by Rant value index write operations.
The result type used by Rant value key read operations.
The result type used by Rant value key write operations.
The result type used by Rant value operators and conversion.
The result type used by Rant value slice read operations.
The result type used by Rant value slice write operations.