Struct ScriptLoader 

pub struct ScriptLoader { /* private fields */ }

Script loader with configurable search paths.

Search order: configured search paths in order added.

Implementations

impl ScriptLoader

pub fn new(sandbox: Arc<dyn SandboxPolicy>) -> Self

Creates a new loader.

The sandbox is passed to all components loaded by this loader.

pub fn with_path(self, path: impl AsRef<Path>) -> Self

Adds a search path.

Paths are searched in the order they are added.

pub fn with_project_root(self, root: impl AsRef<Path>) -> Self

Adds project root’s scripts/ directory to search paths.

Convenience method for with_path(root.join("scripts")).

pub fn with_paths( self, paths: impl IntoIterator<Item = impl AsRef<Path>>, ) -> Self

Adds multiple search paths.

pub fn search_paths(&self) -> &[PathBuf]

Returns configured search paths.

pub fn load(&self, name: &str) -> Result<LuaComponent, LuaError>

Loads a script by name.

Search order:

1. Each search path: {path}/{name}.lua (single file)
2. Each search path: {path}/{name}/init.lua (directory with co-located modules)

Directory-based loading sets up package.path so that standard require() resolves co-located modules within the component directory.

Errors

Returns error if script not found in any location.

pub fn list_available(&self) -> Vec<String>

Lists all available script names.

Includes scripts from all search paths and embedded (if enabled).

pub fn load_all(&self) -> LoadResult

Loads all scripts from configured search paths.

Scans each search path for .lua files and attempts to load them. Errors are collected as warnings, not propagated—allowing partial success.

Example

let loader = ScriptLoader::new()
    .with_path("~/.orcs/scripts")
    .with_path(".orcs/scripts");

let result = loader.load_all();

// Log warnings but continue
for warn in &result.warnings {
    eprintln!("Warning: {}", warn);
}

// Use loaded components
for (name, component) in result.loaded {
    println!("Loaded: {}", name);
}

pub fn load_dir(path: &Path, sandbox: Arc<dyn SandboxPolicy>) -> LoadResult

Loads all scripts from a single directory.

Convenience method equivalent to:

ScriptLoader::new(sandbox)
    .with_path(path)
    .load_all()

pub fn load_file<P: AsRef<Path>>( path: P, sandbox: Arc<dyn SandboxPolicy>, ) -> Result<LuaComponent, LuaError>

Loads a script from a specific file path.

Errors

Returns error if file not found or invalid.

pub fn crate_scripts_dir() -> PathBuf

Returns the crate’s built-in scripts directory.

This is the scripts/ directory relative to the crate root. Mainly useful for development and testing.

Trait Implementations

impl Clone for ScriptLoader

fn clone(&self) -> ScriptLoader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptLoader

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

Formats the value using the given formatter.