Skip to main content

FsResolver

Struct FsResolver 

Source
pub struct FsResolver { /* private fields */ }
Expand description

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§

Source§

impl FsResolver

Source

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

Build an FsResolver backed by the real filesystem.

Source

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

Inject an arbitrary SandboxedFs implementation.

Source

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

Apply a LuaConvention in bulk.

Source

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

Change the file extension (default: lua).

Source

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}.

Source

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§

Source§

impl Resolver for FsResolver

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> MaybeSend for T