Struct TextRequirer 

pub struct TextRequirer { /* private fields */ }

Available on crate feature luau only.

The standard implementation of Luau require-by-string navigation.

Implementations

impl TextRequirer

pub fn new() -> Self

Available on crate features luau only.

Creates a new TextRequirer instance.

Trait Implementations

impl Debug for TextRequirer

Available on crate features luau only.

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

Formats the value using the given formatter.

impl Default for TextRequirer

Available on crate features luau only.

fn default() -> TextRequirer

Returns the “default value” for a type.

impl Require for TextRequirer

Available on crate features luau only.

fn is_require_allowed(&self, chunk_name: &str) -> bool

Available on crate feature luau only.

Returns true if “require” is permitted for the given chunk name.

fn reset(&mut self, chunk_name: &str) -> StdResult<(), NavigateError>

Available on crate feature luau only.

Resets the internal state to point at the requirer module.

fn jump_to_alias(&mut self, path: &str) -> StdResult<(), NavigateError>

Available on crate feature luau only.

Resets the internal state to point at an aliased module.

fn to_parent(&mut self) -> StdResult<(), NavigateError>

Available on crate feature luau only.

fn to_child(&mut self, name: &str) -> StdResult<(), NavigateError>

Available on crate feature luau only.

Navigate to the given child directory.

fn has_module(&self) -> bool

Available on crate feature luau only.

Returns whether the context is currently pointing at a module

fn cache_key(&self) -> String

Available on crate feature luau only.

Provides a cache key representing the current module.

fn has_config(&self) -> bool

Available on crate feature luau only.

Returns whether a configuration is present in the current context.

fn config(&self) -> IoResult<Vec<u8>>

Available on crate feature luau only.

Returns the contents of the configuration file in the current context.

fn loader(&self, lua: &Lua) -> Result<Function>

Available on crate feature luau only.

Returns a loader function for the current module, that when called, loads the module and returns the result.