Struct DefinitionBuilder

Source

pub struct DefinitionBuilder {
    pub entries: Vec<Entry>,
}

Expand description

Builder for definition entries

Fields§

§entries: Vec<Entry>

Implementations§

Source §

impl DefinitionBuilder

Source

pub fn function<'lua, Params, Returns>( self, name: impl Display, _: impl IntoTypedFunction<'lua, Params, Returns>, ) -> Self
where Params: TypedMultiValue, Returns: TypedMultiValue,

Register a definition entry that is a function type

Source

pub fn function_with<'lua, Params, Returns, F>( self, name: impl Display, _: impl IntoTypedFunction<'lua, Params, Returns>, generator: F, ) -> Self
where Params: TypedMultiValue, Returns: TypedMultiValue, F: Fn(&mut FunctionBuilder<Params, Returns>),

Register a definition entry that is a function type

Also add additional documentation

Source

pub fn register<T: Typed>(self, name: impl Into<Cow<'static, str>>) -> Self

Register a type

Source

pub fn register_as( self, name: impl Into<Cow<'static, str>>, ty: impl Into<Type>, ) -> Self

Register a already built type.

Source

pub fn module<T: TypedModule>(self, name: impl Display) -> Self

Register a definition entry that is a class type

The name of the class is the same as the name of the type passed

Source

pub fn module_with<T: TypedModule, S: Display>( self, name: impl Display, doc: Option<S>, ) -> Self

Same as module but with additional docs

Source

pub fn value<T: Typed>(self, name: impl Display) -> Self

Register a value that is available

This can be a table, union/enum, literal, or any other value and it will be typed with the given type

§Example

user mlua_extras::{typed::{Definitions, TypedUserData}, Typed, UserData};

#[derive(UserData, Typed)]
struct Example {
    color: String
}
impl TypedUserData for Example {
    fn add_documentation<F: mlua_extras::typed::TypedDataDocumentation<Self>>(docs: &mut F) {
        docs.add("This is an example");
    }
     
    fn add_fields<'lua, F: TypedDataFields<'lua, Self>>(fields: &mut F) {
        fields
            .document("Example field")
            .add_field_method_get_set(
                "color",
                |_lua, this| Ok(this.color),
                |_lua, this, clr: String| {
                    this.color = clr;
                    Ok(())
                },
            );
    }
}

Definitions::generate("init")
    .register::<Example>("Example")
    .value::<Example>("example")
    .finish();

--- init.d.lua
--- @meta

--- This is an example
--- @class Example
--- Example field
--- @field color string

--- The example module
--- @type Example
example = nil

Source