luars 0.26.2

A library for lua 5.5 runtime implementation in 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Lua Runtime.
//!
//! # Example
//! ```ignore
//! use luars::{Lua, LuaApi, SafeOption};
//!
//! let mut lua = Lua::new(SafeOption::default());
//! let value: i64 = lua.load("return 40 + 2").eval()?;
//! assert_eq!(value, 42);
//! # Ok::<(), luars::LuaError>(())
//! ```

// Allow the derive macro to use `luars::...` paths even inside this crate
extern crate self as luars;

#[cfg(test)]
mod test;

mod compiler;
mod gc;
mod lib_registry;
mod lua_api;
mod lua_value;
mod lua_vm;
mod platform_time;
mod stdlib;

#[cfg(feature = "serde")]
pub mod serde;

// Re-export the derive macros so users can `use luars::LuaUserData;`
pub use luars_derive::LuaUserData;
pub use luars_derive::lua_methods;

// Re-export userdata trait types at crate root for convenience
pub use lua_value::LuaUserdata;
pub use lua_value::UserDataBuilder;
pub use lua_value::alive_ref::RefAliveToken;
pub use lua_value::userdata_trait::{
    LuaEnum, LuaMethodProvider, LuaRegistrable, LuaStaticMethodProvider, OpaqueUserData, UdValue,
    UserDataTrait,
};

pub use lib_registry::{LibraryModule, LibraryRegistry, LuaLibrary, PreloadModule};
pub use lua_api::*;
pub use lua_value::RustCallback;
pub use lua_value::lua_convert::{FromLua, FromLuaMulti, IntoLua};
pub use lua_value::{
    LuaProto, LuaRawFunction, LuaRawTable, LuaValue, LuaValueKind, chunk_serializer::*,
};
pub use lua_vm::SafeOption;
#[cfg(feature = "sandbox")]
pub use lua_vm::SandboxConfig;
pub use lua_vm::async_thread::{
    AsyncCallHandle, AsyncFuture, AsyncReturnValue, AsyncThread, IntoAsyncLua,
};
pub use lua_vm::lua_error::{LuaError, LuaFullError};
pub use lua_vm::{
    CFunction, CallInfo, DebugInfo, GlobalState, Instruction, LuaAnyRef, LuaFunctionRef, LuaResult,
    LuaState, LuaStringRef, LuaTableRef, OpCode, UserDataRef,
};
pub use lua_vm::{LUA_MASKCALL, LUA_MASKCOUNT, LUA_MASKLINE, LUA_MASKRET};
pub use stdlib::Stdlib;

#[cfg(feature = "unsafe-send")]
mod send_impls {
    use crate::RefAliveToken;
    use crate::lua_api::Lua;
    use crate::lua_value::LuaValue;
    use crate::lua_vm::{
        GlobalState, LuaAnyRef, LuaFunctionRef, LuaState, LuaStringRef, LuaTableRef, UserDataRef,
    };

    unsafe impl Send for GlobalState {}
    unsafe impl Sync for GlobalState {}

    unsafe impl Send for LuaState {}
    unsafe impl Sync for LuaState {}

    unsafe impl Send for Lua {}
    unsafe impl Sync for Lua {}

    unsafe impl Send for LuaValue {}
    unsafe impl Sync for LuaValue {}

    unsafe impl Send for RefAliveToken {}
    unsafe impl Sync for RefAliveToken {}

    unsafe impl<T: 'static> Send for UserDataRef<T> {}
    unsafe impl<T: 'static> Sync for UserDataRef<T> {}

    unsafe impl Send for LuaTableRef {}
    unsafe impl Sync for LuaTableRef {}

    unsafe impl Send for LuaFunctionRef {}
    unsafe impl Sync for LuaFunctionRef {}

    unsafe impl Send for LuaAnyRef {}
    unsafe impl Sync for LuaAnyRef {}

    unsafe impl Send for LuaStringRef {}
    unsafe impl Sync for LuaStringRef {}
}