Struct mlua_extras::typed::Class

pub struct Class {
    pub type_doc: Vec<String>,
    pub fields: BTreeMap<Cow<'static, str>, Field>,
    pub static_fields: BTreeMap<Cow<'static, str>, Field>,
    pub meta_fields: BTreeMap<Cow<'static, str>, Field>,
    pub methods: BTreeMap<Cow<'static, str>, Fun>,
    pub meta_methods: BTreeMap<Cow<'static, str>, Fun>,
    pub functions: BTreeMap<Cow<'static, str>, Fun>,
    pub meta_functions: BTreeMap<Cow<'static, str>, Fun>,
    /* private fields */
}

Type information for a lua class. This happens to be a TypedUserData

Fields

type_doc: Vec<String>

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

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

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

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

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

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

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

Implementations

impl Class

pub fn new<T: TypedUserData>() -> Self

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Class

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

Formats the value using the given formatter.

impl Default for Class

fn default() -> Class

Returns the “default value” for a type.

impl Ord for Class

fn cmp(&self, other: &Class) -> 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 Class

fn eq(&self, other: &Class) -> 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 Class

fn partial_cmp(&self, other: &Class) -> 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<T: TypedUserData> TypedDataDocumentation<T> for Class

fn add(&mut self, doc: &str) -> &mut Self

impl<'lua, T: TypedUserData> TypedDataFields<'lua, T> for Class

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

Adds documentation to the next field that gets added

fn add_field<V>(&mut self, name: impl AsRef<str>, _: V)

where V: IntoLua<'lua> + Clone + 'static + Typed,

Typed version of add_field

fn add_field_function_set<S, A, F>(&mut self, name: &S, _: F)

where S: AsRef<str> + ?Sized, A: FromLua<'lua> + Typed, F: 'static + MaybeSend + FnMut(&'lua Lua, AnyUserData<'lua>, A) -> Result<()>,

Typed version of add_field_function_set

fn add_field_function_get<S, R, F>(&mut self, name: &S, _: F)

where S: AsRef<str> + ?Sized, R: IntoLua<'lua> + Typed, F: 'static + MaybeSend + Fn(&'lua Lua, AnyUserData<'lua>) -> Result<R>,

Typed version of add_field_function_get

fn add_field_function_get_set<S, R, A, GET, SET>( &mut self, name: &S, _: GET, _: SET, )

where S: AsRef<str> + ?Sized, R: IntoLua<'lua> + Typed, A: FromLua<'lua> + Typed, GET: 'static + MaybeSend + Fn(&'lua Lua, AnyUserData<'lua>) -> Result<R>, SET: 'static + MaybeSend + Fn(&'lua Lua, AnyUserData<'lua>, A) -> Result<()>,

Typed version of add_field_function_get and add_field_function_set combined

fn add_field_method_set<S, A, M>(&mut self, name: &S, _: M)

where S: AsRef<str> + ?Sized, A: FromLua<'lua> + Typed, M: 'static + MaybeSend + FnMut(&'lua Lua, &mut T, A) -> Result<()>,

Typed version of dd_field_method_set

fn add_field_method_get<S, R, M>(&mut self, name: &S, _: M)

where S: AsRef<str> + ?Sized, R: IntoLua<'lua> + Typed, M: 'static + MaybeSend + Fn(&'lua Lua, &T) -> Result<R>,

Typed version of add_field_method_get

fn add_field_method_get_set<S, R, A, GET, SET>( &mut self, name: &S, _: GET, _: SET, )

where S: AsRef<str> + ?Sized, R: IntoLua<'lua> + Typed, A: FromLua<'lua> + Typed, GET: 'static + MaybeSend + Fn(&'lua Lua, &T) -> Result<R>, SET: 'static + MaybeSend + Fn(&'lua Lua, &mut T, A) -> Result<()>,

Typed version of add_field_method_get and add_field_method_set combined

fn add_meta_field_with<R, F>(&mut self, meta: MetaMethod, _: F)

where F: 'static + MaybeSend + Fn(&'lua Lua) -> Result<R>, R: IntoLua<'lua> + Typed,

Typed version of add_meta_field_with

impl<'lua, T: TypedUserData> TypedDataMethods<'lua, T> for Class

fn document(&mut self, documentation: &str) -> &mut Self

Adds documentation to the next method/function that gets added

fn add_method<S, A, R, M>(&mut self, name: &S, _: M)

where S: ?Sized + AsRef<str>, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, M: 'static + MaybeSend + Fn(&'lua Lua, &T, A) -> Result<R>,

Exposes a method to lua

fn add_function<S, A, R, F>(&mut self, name: &S, _: F)

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

Exposes a function to lua (its a method that does not take Self)

fn add_method_mut<S, A, R, M>(&mut self, name: &S, _: M)

where S: ?Sized + AsRef<str>, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, M: 'static + MaybeSend + FnMut(&'lua Lua, &mut T, A) -> Result<R>,

Exposes a method to lua that has a mutable reference to Self

fn add_meta_method<A, R, M>(&mut self, meta: MetaMethod, _: M)

where A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, M: 'static + MaybeSend + Fn(&'lua Lua, &T, A) -> Result<R>,

Exposes a meta method to lua http://lua-users.org/wiki/MetatableEvents

fn add_async_method<'s, S: ?Sized + AsRef<str>, A, R, M, MR>( &mut self, name: &S, _: M, )

where T: 'static, M: Fn(&'lua Lua, &'s T, A) -> MR + MaybeSend + 'static, A: FromLuaMulti<'lua> + TypedMultiValue, MR: Future<Output = Result<R>> + 's, R: IntoLuaMulti<'lua> + TypedMultiValue, 'lua: 's,

exposes an async method to lua

fn add_function_mut<S, A, R, F>(&mut self, name: &S, _: F)

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

Exposes a mutable function to lua

fn add_meta_function<A, R, F>(&mut self, meta: MetaMethod, _: F)

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

Exposes a meta function to lua http://lua-users.org/wiki/MetatableEvents

fn add_async_function<S, A, R, F, FR>(&mut self, name: &S, _: F)

where S: AsRef<str> + ?Sized, A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, F: 'static + MaybeSend + Fn(&'lua Lua, A) -> FR, FR: 'lua + Future<Output = Result<R>>,

exposes an async function to lua

fn add_meta_method_mut<A, R, M>(&mut self, meta: MetaMethod, _: M)

where A: FromLuaMulti<'lua> + TypedMultiValue, R: IntoLuaMulti<'lua> + TypedMultiValue, M: 'static + MaybeSend + FnMut(&'lua Lua, &mut T, A) -> Result<R>,

Exposes a meta and mutable method to lua http://lua-users.org/wiki/MetatableEvents

fn add_meta_function_mut<A, R, F>(&mut self, meta: MetaMethod, _: F)

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

Exposes a meta and mutable function to lua http://lua-users.org/wiki/MetatableEvents

impl Eq for Class

impl StructuralPartialEq for Class