tsuki 0.4.8

Lua 5.4 ported to Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

use crate::Lua;
use alloc::boxed::Box;

/// Provides interface for Rust to create a Lua module.
///
/// Use [Lua::use_module()] to load the value of this implementation.
pub trait Module<A> {
    /// Preferred name of the module.
    ///
    /// This also name of global variable for the module.
    ///
    /// Note that module user can override this name.
    const NAME: &str;

    /// Type of module instance.
    ///
    /// The value of this type is the value that will be returned from `require` with [Module::NAME]
    /// and also the value of global variable if user choose to create one for this module.
    ///
    /// This can be anything that can be converted to [UnsafeValue](crate::UnsafeValue). If
    /// [Nil](crate::Nil) the module will not be available on both `require` and global variable. In
    /// this case the module with the same name is allowed.
    type Inst<'a>
    where
        A: 'a;

    /// Open this module on `lua`.
    fn open(self, lua: &Lua<A>) -> Result<Self::Inst<'_>, Box<dyn core::error::Error>>;
}