Struct FsResolver 

pub struct FsResolver { /* private fields */ }

Sandboxed filesystem Resolver.

Resolves require("lib.helper") to {root}/lib/helper.lua. Converts module separator to path separator and searches in order:

1. {root}/{name}.{extension}
2. {root}/{name}/{init_name}.{extension}

Defaults to LuaConvention::LUA54. Use with_convention() for bulk changes, or individual methods for partial overrides.

I/O goes through the SandboxedFs trait. Use with_sandbox to inject test mocks or alternative backends.

Errors

new() returns InitError::RootNotFound if the root does not exist.

Implementations

impl FsResolver

pub fn new(root: impl Into<PathBuf>) -> Result<Self, InitError>

Build an FsResolver backed by the real filesystem.

Uses FsSandbox, which rejects any path whose canonical form escapes root. A symlink under root that points outside it is an escape by that rule, so package layouts built from symlinks (including the one mlua-pkg install writes by default) need new_symlink_aware instead.

Root contains	Constructor
Only real files and directories	new
Symlinks to external package sources	new_symlink_aware
Untrusted input (TOCTOU matters)	with_sandbox + CapSandbox

pub fn new_symlink_aware(root: impl Into<PathBuf>) -> Result<Self, InitError>

Build an FsResolver that follows symlinks located directly under root.

Uses SymlinkAwareSandbox: targets of those symlinks become additional allowed roots, so require("pkg") resolves through root/pkg -> /elsewhere/pkg/init.lua instead of failing with ResolveError::PathTraversal.

Use this whenever the root is populated by a linking package manager (mlua-pkg install, npm link, alc_pkg_link) or contains development convenience symlinks.

use mlua_pkg::resolvers::FsResolver;

let resolver = FsResolver::new_symlink_aware("./blocks")?;

Errors

Returns InitError::RootNotFound if root does not exist.

pub fn with_sandbox(sandbox: impl SandboxedFs + 'static) -> Self

Inject an arbitrary SandboxedFs implementation.

pub fn with_convention(self, conv: LuaConvention) -> Self

Apply a LuaConvention in bulk.

pub fn with_extension(self, ext: impl Into<String>) -> Self

Change the file extension (default: lua).

pub fn with_init_name(self, name: impl Into<String>) -> Self

Change the package entry point filename (default: init).

require("pkg") resolves to pkg/{init_name}.{extension}.

pub fn with_module_separator(self, sep: char) -> Self

Change the module name separator (default: .).

require("a{sep}b") is converted to a/b.{extension}.

Trait Implementations

impl Resolver for FsResolver

fn resolve(&self, lua: &Lua, name: &str) -> Option<Result<Value>>