luaur-rt 0.1.2

Safe, ergonomic, mlua-style API for luaur (pure-Rust Luau).
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

//! Integration-style unit tests exercising the mlua-style API end to end.

use crate::prelude::*;
// `Arc<AtomicI64>` (rather than `Rc<Cell<i64>>`) so this capturing-closure test
// also compiles under the `send` feature, where `create_function`'s closure
// must be `Send`. Behaviorally identical in the single-threaded default build.
use std::sync::atomic::{AtomicI64, Ordering};
use std::sync::Arc;

#[test]
fn create_function_and_call_from_lua() {
    let lua = Lua::new();
    let add = lua
        .create_function(|_, (a, b): (i64, i64)| Ok(a + b))
        .unwrap();
    lua.globals().set("add", add).unwrap();
    let result: i64 = lua.load("return add(2, 3)").eval().unwrap();
    assert_eq!(result, 5);
}

#[test]
fn capturing_closure_counter() {
    let lua = Lua::new();
    let counter = Arc::new(AtomicI64::new(0));
    let c2 = counter.clone();
    let inc = lua
        .create_function(move |_, ()| Ok(c2.fetch_add(1, Ordering::SeqCst) + 1))
        .unwrap();
    lua.globals().set("inc", inc).unwrap();
    lua.load("inc(); inc(); inc()").exec().unwrap();
    assert_eq!(counter.load(Ordering::SeqCst), 3);
    let last: i64 = lua.load("return inc()").eval().unwrap();
    assert_eq!(last, 4);
    assert_eq!(counter.load(Ordering::SeqCst), 4);
}

#[test]
fn scalar_string_bool_option_round_trips() {
    let lua = Lua::new();

    let i: i64 = lua.load("return 42").eval().unwrap();
    assert_eq!(i, 42);

    let f: f64 = lua.load("return 3.5").eval().unwrap();
    assert_eq!(f, 3.5);

    let s: String = lua.load("return 'hello'").eval().unwrap();
    assert_eq!(s, "hello");

    let b: bool = lua.load("return true").eval().unwrap();
    assert!(b);

    let none: Option<i64> = lua.load("return nil").eval().unwrap();
    assert_eq!(none, None);

    let some: Option<i64> = lua.load("return 7").eval().unwrap();
    assert_eq!(some, Some(7));

    // Round-trip through a Rust function: identity on each type.
    let id_i = lua.create_function(|_, x: i64| Ok(x)).unwrap();
    lua.globals().set("id_i", id_i).unwrap();
    let back: i64 = lua.load("return id_i(123)").eval().unwrap();
    assert_eq!(back, 123);

    let id_s = lua.create_function(|_, x: String| Ok(x)).unwrap();
    lua.globals().set("id_s", id_s).unwrap();
    let back_s: String = lua.load("return id_s('world')").eval().unwrap();
    assert_eq!(back_s, "world");
}

#[test]
fn table_set_get_nested() {
    let lua = Lua::new();
    let t = lua.create_table();
    t.set("a", 1i64).unwrap();
    t.set("b", "two").unwrap();
    let inner = lua.create_table();
    inner.set("x", 10i64).unwrap();
    t.set("inner", inner).unwrap();

    let a: i64 = t.get("a").unwrap();
    assert_eq!(a, 1);
    let b: String = t.get("b").unwrap();
    assert_eq!(b, "two");
    assert!(t.contains_key("a").unwrap());
    assert!(!t.contains_key("missing").unwrap());

    let inner: Table = t.get("inner").unwrap();
    let x: i64 = inner.get("x").unwrap();
    assert_eq!(x, 10);
}

#[test]
fn vec_to_and_from_table() {
    let lua = Lua::new();
    // Vec -> table -> Lua, summed in Lua, back to Rust.
    let v = vec![1i64, 2, 3, 4];
    lua.globals().set("nums", v.clone()).unwrap();
    let len: i64 = lua.load("return #nums").eval().unwrap();
    assert_eq!(len, 4);
    let sum: i64 = lua
        .load("local s = 0; for _, n in ipairs(nums) do s = s + n end; return s")
        .eval()
        .unwrap();
    assert_eq!(sum, 10);

    // Lua sequence -> Rust Vec.
    let back: Vec<i64> = lua.load("return {10, 20, 30}").eval().unwrap();
    assert_eq!(back, vec![10, 20, 30]);
}

#[test]
fn table_pairs_iteration() {
    let lua = Lua::new();
    let t = lua.create_table();
    t.set("a", 1i64).unwrap();
    t.set("b", 2i64).unwrap();
    t.set("c", 3i64).unwrap();
    let mut sum = 0i64;
    let mut keys = Vec::new();
    for pair in t.pairs::<String, i64>() {
        let (k, v) = pair.unwrap();
        keys.push(k);
        sum += v;
    }
    keys.sort();
    assert_eq!(keys, vec!["a", "b", "c"]);
    assert_eq!(sum, 6);
}

#[test]
fn call_lua_function_from_rust() {
    let lua = Lua::new();
    let doubler: Function = lua
        .load("return function(x) return x * 2 end")
        .eval()
        .unwrap();
    let r: i64 = doubler.call(21i64).unwrap();
    assert_eq!(r, 42);
}

#[test]
fn rust_error_is_catchable_by_lua_pcall() {
    let lua = Lua::new();
    let boom = lua
        .create_function(|_, ()| -> Result<()> { Err(Error::runtime("kaboom")) })
        .unwrap();
    lua.globals().set("boom", boom).unwrap();
    // pcall should catch the error and report ok=false plus the message.
    let msg: String = lua
        .load("local ok, err = pcall(boom); assert(not ok); return tostring(err)")
        .eval()
        .unwrap();
    assert!(
        msg.contains("kaboom"),
        "expected message to contain kaboom: {msg}"
    );
}

#[test]
fn lua_error_call_surfaces_as_err() {
    let lua = Lua::new();
    let err = lua.load("error('boom')").exec().unwrap_err();
    let text = err.to_string();
    assert!(text.contains("boom"), "error should mention boom: {text}");
}

#[test]
fn rust_panic_in_closure_becomes_lua_error_not_abort() {
    let lua = Lua::new();
    let panicky = lua
        .create_function(|_, ()| -> Result<()> {
            panic!("intentional panic from rust callback");
        })
        .unwrap();
    lua.globals().set("panicky", panicky).unwrap();
    // The panic must be caught and converted to a catchable Lua error — the
    // process must NOT abort.
    let caught: String = lua
        .load("local ok, err = pcall(panicky); assert(not ok); return tostring(err)")
        .eval()
        .unwrap();
    assert!(
        caught.contains("intentional panic"),
        "panic message should surface: {caught}"
    );

    // And calling it directly (no pcall) surfaces as Err on the Rust side.
    let direct = lua.load("panicky()").exec();
    assert!(direct.is_err());
}

// --- UserData ------------------------------------------------------------

struct Vec2 {
    x: f64,
    y: f64,
}

impl UserData for Vec2 {
    fn add_methods<M: UserDataMethods<Self>>(methods: &mut M) {
        methods.add_method("magnitude", |_, this, ()| {
            Ok((this.x * this.x + this.y * this.y).sqrt())
        });
        methods.add_method("get_x", |_, this, ()| Ok(this.x));
        methods.add_method_mut("scale", |_, this, factor: f64| {
            this.x *= factor;
            this.y *= factor;
            Ok(())
        });
        // __add meta-method: returns the component-wise sum's magnitude (we
        // can't easily return a fresh Vec2 userdata from here without a
        // constructor, so we return a number to keep the test self-contained).
        methods.add_meta_method("__add", |_, this, other: f64| Ok(this.x + this.y + other));
    }
}

#[test]
fn userdata_method_from_lua() {
    let lua = Lua::new();
    let v = lua.create_userdata(Vec2 { x: 3.0, y: 4.0 }).unwrap();
    lua.globals().set("v", v).unwrap();

    let mag: f64 = lua.load("return v:magnitude()").eval().unwrap();
    assert!((mag - 5.0).abs() < 1e-9, "magnitude should be 5, got {mag}");

    let x: f64 = lua.load("return v:get_x()").eval().unwrap();
    assert_eq!(x, 3.0);
}

#[test]
fn userdata_method_mut_from_lua() {
    let lua = Lua::new();
    let v = lua.create_userdata(Vec2 { x: 3.0, y: 4.0 }).unwrap();
    lua.globals().set("v", v).unwrap();
    let mag: f64 = lua.load("v:scale(2); return v:magnitude()").eval().unwrap();
    assert!(
        (mag - 10.0).abs() < 1e-9,
        "scaled magnitude should be 10, got {mag}"
    );
}

#[test]
fn userdata_meta_method_add() {
    let lua = Lua::new();
    let v = lua.create_userdata(Vec2 { x: 3.0, y: 4.0 }).unwrap();
    lua.globals().set("v", v).unwrap();
    // v + 10 -> __add(v, 10) -> 3 + 4 + 10 = 17
    let r: f64 = lua.load("return v + 10").eval().unwrap();
    assert_eq!(r, 17.0);
}

#[test]
fn variadic_args() {
    let lua = Lua::new();
    let sum = lua
        .create_function(|_, nums: Variadic<i64>| Ok(nums.iter().sum::<i64>()))
        .unwrap();
    lua.globals().set("vsum", sum).unwrap();
    let r: i64 = lua.load("return vsum(1, 2, 3, 4, 5)").eval().unwrap();
    assert_eq!(r, 15);
}

#[test]
fn multiple_return_values_via_tuple() {
    let lua = Lua::new();
    let (a, b, c): (i64, String, bool) = lua.load("return 1, 'two', true").eval().unwrap();
    assert_eq!(a, 1);
    assert_eq!(b, "two");
    assert!(c);
}

#[test]
fn integer_range_check_rejects_overflow() {
    let lua = Lua::new();
    // u8 from a number larger than 255 should fail conversion.
    let id_u8 = lua.create_function(|_, x: u8| Ok(x)).unwrap();
    lua.globals().set("id_u8", id_u8).unwrap();
    let err = lua.load("return id_u8(300)").exec();
    assert!(err.is_err(), "u8 conversion from 300 must error");
}