Struct InitCx 

pub struct InitCx {
    pub app_dir: PathBuf,
    pub app_id: String,
    pub headless: bool,
    pub hot_reload: bool,
    pub lumen_version: String,
    /* private fields */
}

What a plugin knows about the app it was loaded into.

Fields

app_dir: PathBuf

The app directory, canonicalized. A plugin resolves its own files against this rather than against the process’s working directory.

app_id: String

The app’s id from lumen.toml, or its directory name when it declares none.

headless: bool

True when the app runs without a window.

hot_reload: bool

True when the app was started with hot reload on, so a plugin that caches derived state knows the sources under it can change.

lumen_version: String

The engine’s version, as a semver string.

Implementations

impl InitCx

pub fn new( app_dir: PathBuf, app_id: String, headless: bool, hot_reload: bool, lumen_version: String, config_toml: String, ) -> Self

Build a context. Host-side; a plugin only ever reads one.

pub fn config<T: DeserializeOwned>(&self) -> Result<T, Error>

Deserialize the module’s config table into any serde type. An app that declares no table yields the type’s view of an empty table.

Trait Implementations

impl Clone for InitCx

fn clone(&self) -> InitCx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitCx

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitCx

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InitCx

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.