Struct TypedModuleBuilder

pub struct TypedModuleBuilder {
    pub doc: Option<Cow<'static, str>>,
    pub nested_modules: BTreeMap<Cow<'static, str>, TypedModuleBuilder>,
    pub fields: BTreeMap<Cow<'static, str>, Field>,
    pub meta_fields: BTreeMap<Cow<'static, str>, Field>,
    pub functions: BTreeMap<Cow<'static, str>, Func>,
    pub methods: BTreeMap<Cow<'static, str>, Func>,
    pub meta_functions: BTreeMap<Cow<'static, str>, Func>,
    pub meta_methods: BTreeMap<Cow<'static, str>, Func>,
    /* private fields */
}

Builder that constructs type and documentation information for a module using the TypedModule trait

Fields

doc: Option<Cow<'static, str>>

nested_modules: BTreeMap<Cow<'static, str>, TypedModuleBuilder>

fields: BTreeMap<Cow<'static, str>, Field>

meta_fields: BTreeMap<Cow<'static, str>, Field>

functions: BTreeMap<Cow<'static, str>, Func>

methods: BTreeMap<Cow<'static, str>, Func>

meta_functions: BTreeMap<Cow<'static, str>, Func>

meta_methods: BTreeMap<Cow<'static, str>, Func>

Implementations

impl TypedModuleBuilder

pub fn new<M: TypedModule>() -> Result<Self>

pub fn is_empty(&self) -> bool

pub fn is_meta_empty(&self) -> bool

Trait Implementations

impl Clone for TypedModuleBuilder

fn clone(&self) -> TypedModuleBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypedModuleBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TypedModuleBuilder

fn default() -> TypedModuleBuilder

Returns the “default value” for a type.

impl Ord for TypedModuleBuilder

fn cmp(&self, other: &TypedModuleBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TypedModuleBuilder

fn eq(&self, other: &TypedModuleBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TypedModuleBuilder

fn partial_cmp(&self, other: &TypedModuleBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'lua> TypedModuleFields<'lua> for TypedModuleBuilder

fn document<V: AsRef<str>>(&mut self, doc: V) -> &mut Self

Queue a doc comment to be used with the nest add call

fn add_module<V>(&mut self, name: impl AsRef<str>) -> Result<()>

where V: TypedModule,

Typed variant of add_module only collecting the type information

fn add_field<K, V>(&mut self, name: K, _value: V) -> Result<()>

where K: AsRef<str>, V: IntoLua<'lua> + Typed,

Typed variant of add_field only collecting the type information

fn add_meta_field<K, V>(&mut self, name: K, _value: V) -> Result<()>

where K: AsRef<str>, V: IntoLua<'lua> + Typed,

Typed variant of add_meta_field only collecting the type information

impl<'lua> TypedModuleMethods<'lua> for TypedModuleBuilder

fn document<V: AsRef<str>>(&mut self, doc: V) -> &mut Self

Queue a doc comment to be used with the nest add call

fn add_function<K, F, A, R>(&mut self, name: K, _function: F) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue,

Typed variant of add_function only collecting the type information

fn add_function_with<K, F, A, R, G>( &mut self, name: K, _function: F, generator: G, ) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, G: Fn(&mut FunctionBuilder<A, R>),

Typed variant of add_function only collecting the type information

fn add_meta_function<K, F, A, R>(&mut self, name: K, _function: F) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue,

Typed variant of add_meta_function only collecting the type information

fn add_meta_function_with<K, F, A, R, G>( &mut self, name: K, _function: F, generator: G, ) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, G: Fn(&mut FunctionBuilder<A, R>),

Typed variant of add_meta_function only collecting the type information

fn add_method<K, F, A, R>(&mut self, name: K, _function: F) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, Table<'_>, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue,

Typed variant of add_method only collecting the type information

fn add_method_with<K, F, A, R, G>( &mut self, name: K, _function: F, generator: G, ) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, Table<'_>, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, G: Fn(&mut FunctionBuilder<A, R>),

Typed variant of add_method only collecting the type information

fn add_meta_method<K, F, A, R>(&mut self, name: K, _function: F) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, Table<'_>, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue,

Typed variant of add_meta_method only collecting the type information

fn add_meta_method_with<K, F, A, R, G>( &mut self, name: K, _function: F, generator: G, ) -> Result<()>

where K: AsRef<str>, F: Fn(&Lua, Table<'_>, A) -> Result<R> + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, G: Fn(&mut FunctionBuilder<A, R>),

Typed variant of add_meta_method only collecting the type information

impl Eq for TypedModuleBuilder

impl StructuralPartialEq for TypedModuleBuilder