luars 0.17.0

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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! Fluent builder for constructing Lua tables from Rust.
//!
//! `TableBuilder` collects key-value pairs and then creates the table in one
//! shot via [`build`](TableBuilder::build), which requires `&mut LuaVM` for
//! GC allocation.
//!
//! # Example
//!
//! ```ignore
//! let config = TableBuilder::new()
//!     .set("host", LuaValue::from("localhost"))
//!     .set("port", LuaValue::integer(8080))
//!     .set("debug", LuaValue::boolean(true))
//!     .build(&mut vm)?;
//! vm.set_global("config", config)?;
//! ```

use crate::lua_value::LuaValue;
use crate::lua_vm::{LuaResult, LuaVM};

/// Fluent builder for Lua tables.
///
/// Collects entries (keyed and/or sequential) and materialises them into a
/// single `LuaValue` table when [`build`](Self::build) is called.
pub struct TableBuilder {
    /// Named entries (string key → value).
    entries: Vec<(TableKey, LuaValue)>,
    /// Sequential array entries (1-based).
    array: Vec<LuaValue>,
}

/// Internal key representation — deferred until build-time so we can avoid
/// requiring `&mut LuaVM` during construction.
enum TableKey {
    String(String),
    Integer(i64),
    Value(LuaValue),
}

impl TableBuilder {
    /// Create an empty builder.
    #[inline]
    pub fn new() -> Self {
        TableBuilder {
            entries: Vec::new(),
            array: Vec::new(),
        }
    }

    /// Add a string-keyed entry.
    ///
    /// ```ignore
    /// builder.set("name", LuaValue::from("Alice"))
    /// ```
    #[inline]
    pub fn set(mut self, key: &str, value: LuaValue) -> Self {
        self.entries.push((TableKey::String(key.to_owned()), value));
        self
    }

    /// Add an integer-keyed entry.
    ///
    /// ```ignore
    /// builder.set_int(1, LuaValue::integer(42))
    /// ```
    #[inline]
    pub fn set_int(mut self, key: i64, value: LuaValue) -> Self {
        self.entries.push((TableKey::Integer(key), value));
        self
    }

    /// Add a `LuaValue`-keyed entry (for non-string, non-integer keys).
    #[inline]
    pub fn set_value(mut self, key: LuaValue, value: LuaValue) -> Self {
        self.entries.push((TableKey::Value(key), value));
        self
    }

    /// Append a value to the sequential (array) part of the table.
    ///
    /// Values are assigned keys 1, 2, 3, … in order.
    ///
    /// ```ignore
    /// let list = TableBuilder::new()
    ///     .push(LuaValue::integer(10))
    ///     .push(LuaValue::integer(20))
    ///     .push(LuaValue::integer(30))
    ///     .build(&mut vm)?;
    /// // Lua: {10, 20, 30}
    /// ```
    #[inline]
    pub fn push(mut self, value: LuaValue) -> Self {
        self.array.push(value);
        self
    }

    /// Materialise the table via the VM.
    pub fn build(self, vm: &mut LuaVM) -> LuaResult<LuaValue> {
        let table = vm.create_table(self.array.len(), self.entries.len())?;

        // Array part
        for (i, val) in self.array.into_iter().enumerate() {
            let key = LuaValue::integer((i + 1) as i64);
            vm.raw_set(&table, key, val);
        }

        // Keyed part
        for (k, val) in self.entries {
            let key = match k {
                TableKey::String(s) => vm.create_string(&s)?,
                TableKey::Integer(n) => LuaValue::integer(n),
                TableKey::Value(v) => v,
            };
            vm.raw_set(&table, key, val);
        }

        Ok(table)
    }
}

impl Default for TableBuilder {
    fn default() -> Self {
        Self::new()
    }
}