Struct rant::Rant

pub struct Rant { /* fields omitted */ }

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_options(options: RantOptions) -> Self

Creates a new Rant context with the specified options.

impl Rant

#[must_use = "compiling a program without storing or running it achieves nothing"]pub fn compile<R: Reporter>(
    &self,
    source: &str,
    reporter: &mut R
) -> Result<RantProgram, CompilerErrorKind>

Compiles a source string using the specified reporter.

#[must_use = "compiling a program without storing or running it achieves nothing"]pub fn compile_quiet(
    &self,
    source: &str
) -> Result<RantProgram, CompilerErrorKind>

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.

#[must_use = "compiling a program without storing or running it achieves nothing"]pub fn compile_file<P: AsRef<Path>, R: Reporter>(
    &self,
    path: P,
    reporter: &mut R
) -> Result<RantProgram, CompilerErrorKind>

Compiles a source file using the specified reporter.

#[must_use = "compiling a program without storing or running it achieves nothing"]pub fn compile_file_quiet<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<RantProgram, CompilerErrorKind>

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 globals(&self) -> RantMapRef

Gets the global variable map of the Rant context.

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

Sets a global variable.

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

Gets a global variable.

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 run(&mut self, program: &RantProgram) -> Result<String, RuntimeError>

Runs the specified Rant program and returns the generated output.

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.