Expand description
§Molt Client Library
This module defines the API for Molt clients.
The interp
module defines the Molt interpreter itself, and provides the primary
API. Values in the Molt language are stored internally using the Value
struct. Other
relevant data types, including MoltResult
and ResultCode
, are defined in
the types
module.
The test_harness
module defines the test runner for Molt’s TCL-level testing. It
can be used directly in Cargo integration tests or via a Molt shell, whether standard or
custom.
See The Molt Book for an introduction to Molt.
Re-exports§
pub use crate::types::*;
Modules§
- dict
- Dictionary Utilities
- interp
- The Molt Interpreter
- prelude
- test_
harness - Molt Test Harness
- types
- Public Type Declarations
- value
- The Value Type
Macros§
- _gen_
subcommand_ generic - A Molt command that has subcommands is called an ensemble command. In Rust code,
the ensemble is defined as an array of
Subcommand
structs, each one mapping from a subcommand name to the implementingCommandFunc
. For more information, see the discussion of command definition in The Molt Book and theinterp
module. - gen_
command - gen_
subcommand - A Molt command that has subcommands is called an ensemble command. In Rust code,
the ensemble is defined as an array of
Subcommand
structs, each one mapping from a subcommand name to the implementingCommandFunc
. For more information, see the discussion of command definition in The Molt Book and theinterp
module. - join_
helps - join_
helps_ subcmd - join_
strings - molt_
err - Returns an
Error
MoltResult
. The error message is formatted as withformat!()
. - molt_
err_ help - molt_
err_ uncompleted - molt_ok
- Returns an
Ok
MoltResult
. - molt_
throw - Returns an
Error
MoltResult
with a specific error code. The error message is formatted as withformat!()
.
Functions§
- check_
args - This function is used in command functions to check whether the command’s argument
list is of a proper size for the given command. If it is,
check_args
returns the empty result; if not, it returns a Molt error messagewrong # args: should be "syntax..."
, where syntax is the command’s syntax. It is typically called at the beginning of a command function.