Struct rhai::Definitions

pub struct Definitions<'e> { /* private fields */ }

(metadata, internals) Definitions helper type to generate definition files based on the contents of an Engine. Exported under the internals and metadata feature only.

Implementations

impl Definitions<'_>

pub fn with_headers(self, headers: bool) -> Self

Write module ... headers in separate definitions, default false.

Headers are always present in content that is expected to be written to a file (i.e. write_to* and *_file methods).

pub fn include_standard_packages(self, include_standard_packages: bool) -> Self

Include standard packages when writing definition files.

pub const fn engine(&self) -> &Engine

Get the Engine.

pub const fn scope(&self) -> Option<&Scope<'_>>

Get the Scope.

impl Definitions<'_>

pub fn write_to_dir(&self, path: impl AsRef<Path>) -> Result<()>

Output all definition files returned from iter_files to a specified directory.

This function creates the directories and overrides any existing files if needed.

pub fn write_to_file(&self, path: impl AsRef<Path>) -> Result<()>

Output all definitions merged into a single file.

The parent directory must exist but the file will be created or overwritten as needed.

pub fn single_file(&self) -> String

Return all definitions merged into a single file.

pub fn iter_files(&self) -> impl Iterator<Item = (String, String)> + '_

Iterate over generated definition files.

The returned iterator yields all definition files as (filename, content) pairs.

pub fn builtin_functions(&self) -> String

Return definitions for all builtin functions.

pub fn builtin_functions_operators(&self) -> String

Return definitions for all builtin operators.

pub fn static_module(&self) -> String

Return definitions for all globally available functions and constants.

pub fn scope_items(&self) -> String

Return definitions for all items inside the Scope, if any.

pub fn modules(&self) -> impl Iterator<Item = (String, String)> + '_

Return a (module name, definitions) pair for each registered static module.

Not available under no_module.

impl Definitions<'_>

pub fn json(&self) -> Result<String>

Generate a list of all functions in JSON format.

Functions from the following sources are included:

1. Functions defined in an AST
2. Functions registered into the global namespace
3. Functions in static modules
4. Functions in registered global packages
5. Functions in standard packages (optional)

Trait Implementations

impl<'e> Clone for Definitions<'e>

fn clone(&self) -> Definitions<'e>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'e> Debug for Definitions<'e>

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

Formats the value using the given formatter.