Skip to content
dream-path
api

PathExtension

The l3i extension that provides @dream/path, and the constants a host uses to expose it.

Rust, in the lua module, behind the lua feature. Embedding Luau shows it in a host.

PathExtension#

struct PathExtension

The dream.path extension: an l3i::extension::Extension that describes the @dream/path module and its type signatures. It holds no state; Clone, Copy, Debug, Default. Add it to a plan with RuntimePlan::builder().extension(PathExtension).

It never creates a runtime, picks userdata tags or atoms, or installs a global.

Constants#

const EXTENSION_ID: &str = "dream.path"

The extension’s id in the plan.

const MODULE: &str = "@dream/path"

The path scripts require.

const MODULE_NAME: &str = "dreamPath"

The conventional global, for hosts that expose the module as one: RuntimePolicy::new().compat_global(MODULE, MODULE_NAME).