Struct LuauModulePath 

pub struct LuauModulePath { /* private fields */ }

A resolved module path for Luau, containing both:

• The source Luau module path.
• The target filesystem path.

Note the separation here - the source is not necessarily a valid filesystem path, and the target is not necessarily a valid Luau module path for require-by-string.

See LuauFilePath and LuauModulePath::resolve for more information.

Implementations

impl LuauModulePath

pub fn strip(path: impl Into<PathBuf>) -> PathBuf

Strips Luau file extensions and potential init segments from a given path.

This is the opposite operation of LuauModulePath::resolve and is generally useful for converting between paths in a CLI or other similar use cases - but should never be used to implement require resolution.

Does not use any filesystem calls and will not panic.

pub fn resolve(module: impl Into<PathBuf>) -> Result<Self, LuaNavigateError>

Resolves an existing file or directory path for the given module path.

Given a module path “path/to/module”, these files will be searched:

• path/to/module.luau
• path/to/module.lua
• path/to/module/init.luau
• path/to/module/init.lua

If the given path (“path/to/module”) is a directory instead, and it exists, it will be returned without any modifications.

Errors

• If the given module path is ambiguous.
• If the given module path does not resolve to a valid file or directory.

pub fn source(&self) -> &Path

Returns the source Luau module path.

pub fn target(&self) -> &LuauFilePath

Returns the target filesystem file path.

Trait Implementations

impl Clone for LuauModulePath

fn clone(&self) -> LuauModulePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuauModulePath

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

Formats the value using the given formatter.

impl Display for LuauModulePath

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

Formats the value using the given formatter.

impl PartialEq for LuauModulePath

fn eq(&self, other: &LuauModulePath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for LuauModulePath

impl StructuralPartialEq for LuauModulePath