Struct rant::Rant

pub struct Rant { /* private fields */ }

A Rant execution context.

Implementations

impl Rant

pub fn new() -> Self

Creates a new Rant context with the default seed (0) and loads the standard library.

pub fn with_seed(seed: u64) -> Self

Creates a new Rant context with the specified seed and loads the standard library.

pub fn with_random_seed() -> Self

Creates a new Rant context with a seed generated by a thread-local PRNG and loads the standard library.

pub fn with_options(options: RantOptions) -> Self

Creates a new Rant context with the specified options.

pub fn using_module_resolver<R: ModuleResolver + 'static>(
    self,
    module_resolver: R
) -> Self

Replaces the module resolver.

impl Rant

pub fn compile<R: Reporter>(
    &self,
    source: &str,
    reporter: &mut R
) -> Result<RantProgram, CompilerError>

Compiles a source string using the specified reporter.

pub fn compile_named<R: Reporter>(
    &self,
    source: &str,
    reporter: &mut R,
    name: &str
) -> Result<RantProgram, CompilerError>

Compiles a source string using the specified reporter and source name.

pub fn compile_quiet(&self, source: &str) -> Result<RantProgram, CompilerError>

Compiles a source string without reporting problems.

Note

This method will not generate any compiler messages, even if it fails.

If you require this information, use the compile() method instead.

pub fn compile_quiet_named(
    &self,
    source: &str,
    name: &str
) -> Result<RantProgram, CompilerError>

Compiles a source string without reporting problems and assigns it the specified name.

Note

This method will not generate any compiler messages, even if it fails.

If you require this information, use the compile() method instead.

pub fn compile_file<P: AsRef<Path>, R: Reporter>(
    &self,
    path: P,
    reporter: &mut R
) -> Result<RantProgram, CompilerError>

Compiles a source file using the specified reporter.

pub fn compile_file_quiet<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<RantProgram, CompilerError>

Compiles a source file without reporting problems.

Note

This method will not generate any compiler messages, even if it fails.

If you require this information, use the compile_file() method instead.

pub fn set_global(&mut self, key: &str, value: RantValue) -> bool

Sets a global variable. This will auto-define the global if it doesn’t exist.

If the global already exists and is a constant, the write will not succeed.

Returns true if the write succeeded; otherwise, false.

pub fn set_global_const(&mut self, key: &str, value: RantValue) -> bool

Sets a global constant. This will auto-define the global if it doesn’t exist.

If the global already exists and is a constant, the write will not succeed.

Returns true if the write succeeded; otherwise, false.

pub fn set_global_force(&mut self, key: &str, value: RantValue, is_const: bool)

Sets a global’s value, forcing the write even if the existing global is a constant. This will auto-define the global if it doesn’t exist.

pub fn get_global(&self, key: &str) -> Option<RantValue>

Gets the value of a global variable.

pub fn has_global(&self, key: &str) -> bool

Returns true if a global with the specified key exists.

pub fn delete_global(&mut self, key: &str) -> bool

Removes the global with the specified key. Returns true if the global existed prior to removal.

pub fn global_names(&self) -> impl Iterator<Item = &str>

Iterates over the names of all globals stored in the context.

pub fn options(&self) -> &RantOptions

Gets the options used to initialize the context.

pub fn seed(&self) -> u64

Gets the current RNG seed.

pub fn set_seed(&mut self, seed: u64)

Re-seeds the RNG with the specified seed.

pub fn reset_seed(&mut self)

Resets the RNG back to its initial state with the current seed.

pub fn add_data_source(
    &mut self,
    data_source: impl DataSource + 'static
) -> Result<(), DataSourceRegisterError>

Registers a data source to the context, making it available to scripts.

pub fn remove_data_source(&mut self, name: &str) -> Option<Box<dyn DataSource>>

Removes the data source with the specified name from the context, making it no longer available to scripts.

pub fn has_data_source(&self, name: &str) -> bool

Returns a bool indicating whether a data source with the specified name is present in the context.

pub fn clear_data_sources(&mut self)

Removes all data sources from the context.

pub fn data_source(&self, name: &str) -> Option<&dyn DataSource>

Returns a reference to the data source associated with the specified name.

pub fn iter_data_sources(
    &self
) -> impl Iterator<Item = (&str, &Box<dyn DataSource + 'static>)>

Iterates over all data sources (and their names) in the context.

pub fn run(&mut self, program: &RantProgram) -> RuntimeResult<RantValue>

Runs a program and returns the output value.

pub fn run_with<A>(
    &mut self,
    program: &RantProgram,
    args: A
) -> RuntimeResult<RantValue> where
    A: Into<Option<HashMap<String, RantValue>>>, 

Runs a program with the specified arguments and returns the output value.

pub fn try_load_global_module(
    &mut self,
    module_path: &str
) -> Result<(), ModuleLoadError>

Trait Implementations

impl Debug for Rant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rant

fn default() -> Self

Creates a default Rant instance.