luars 0.24.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

use std::ffi::c_void;

use crate::{FromLua, FromLuaMulti, IntoLua, LuaFunctionRef, LuaResult, LuaValue};

/// Safe wrapper around a callable Lua function handle.
#[derive(Clone, Debug)]
pub struct LuaFunction {
    pub(crate) inner: LuaFunctionRef,
}

impl LuaFunction {
    pub(crate) fn new(inner: LuaFunctionRef) -> Self {
        LuaFunction { inner }
    }

    /// Return the number of upvalues captured by this function.
    #[inline]
    pub fn upvalue_count(&self) -> usize {
        self.inner.upvalue_count()
    }

    /// Read and convert one upvalue.
    #[inline]
    pub fn get_upvalue<T: FromLua>(&self, n: usize) -> LuaResult<Option<(String, T)>> {
        self.inner.get_upvalue(n)
    }

    /// Replace one upvalue.
    #[inline]
    pub fn set_upvalue<T: IntoLua>(&self, n: usize, value: T) -> LuaResult<Option<String>> {
        self.inner.set_upvalue(n, value)
    }

    /// Return an opaque identity for the requested upvalue.
    #[inline]
    pub fn upvalue_id(&self, n: usize) -> Option<*mut c_void> {
        self.inner.upvalue_id(n)
    }

    /// Make two Lua function upvalues share the same storage.
    #[inline]
    pub fn join_upvalue(&self, n1: usize, other: &LuaFunction, n2: usize) -> LuaResult<bool> {
        self.inner.join_upvalue(n1, &other.inner, n2)
    }

    /// Call the function and convert all returned values.
    #[inline]
    pub fn call<A: IntoLua, R: FromLuaMulti>(&self, args: A) -> LuaResult<R> {
        self.inner.call(args)
    }

    /// Call the function and convert the first returned value.
    #[inline]
    pub fn call1<A: IntoLua, R: FromLua>(&self, args: A) -> LuaResult<R> {
        self.inner.call1(args)
    }

    /// # Safety
    /// The returned `LuaValue` must not be used after the `LuaFunction` is
    pub unsafe fn to_value(&self) -> LuaValue {
        self.inner.to_value()
    }
}

impl IntoLua for LuaFunction {
    #[inline]
    fn into_lua(self, state: &mut luars::LuaState) -> Result<usize, String> {
        state
            .push_value(self.inner.to_value())
            .map_err(|e| format!("{:?}", e))?;
        Ok(1)
    }
}

impl IntoLua for &LuaFunction {
    #[inline]
    fn into_lua(self, state: &mut luars::LuaState) -> Result<usize, String> {
        state
            .push_value(self.inner.to_value())
            .map_err(|e| format!("{:?}", e))?;
        Ok(1)
    }
}

impl FromLua for LuaFunction {
    fn from_lua(value: LuaValue, state: &mut luars::LuaState) -> Result<Self, String> {
        let actual = value.type_name();
        let function = state
            .to_function_ref(value)
            .ok_or_else(|| format!("expected function, got {}", actual))?;
        Ok(LuaFunction::new(function))
    }
}