[][src]Crate rant

Rant

Rant is a language for procedural text generation. 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.

The Rant context

All programs are run through a Rant context, represented by the Rant struct. It allows you to execute Rant programs, define and retrieve global variables, manipulate the RNG, and compile Rant code.

Reading compiler errors

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 (), and Vec<CompilerMessage>. You can also make your own custom reporters to suit your specific needs.

Re-exports

pub use value::*;

Modules

compiler
stdlib

The Rant standard library.

value

Structs

Rant

A Rant execution context.

RantList

Represents Rant's list type, which stores an ordered collection of values.

RantMap

Represents Rant's map type, which stores a collection of key-value pairs. Map keys are always strings.

RantProgram

A compiled Rant program.

Constants

BUILD_VERSION

The build version according to the crate metadata at the time of compiling.

RANT_VERSION

The Rant language version implemented by this library.

Traits

AsRantForeignFunc
FromRant

Enables conversion from a RantValue to a native type.

FromRantArgs

Converts from argument list to tuple of impl FromRant values

ToRant

Enables conversion from a native type to a RantValue.

Type Definitions

RantListRef
RantMapRef