Struct mlua::UserDataMetatable

pub struct UserDataMetatable<'lua>(/* private fields */);

Handle to a UserData metatable.

Implementations

impl<'lua> UserDataMetatable<'lua>

pub fn get<V: FromLua<'lua>>(&self, key: impl AsRef<str>) -> Result<V>

Gets the value associated to key from the metatable.

If no value is associated to key, returns the Nil value. Access to restricted metamethods such as __gc or __metatable will cause an error.

pub fn set<V: IntoLua<'lua>>( &self, key: impl AsRef<str>, value: V ) -> Result<()>

Sets a key-value pair in the metatable.

If the value is Nil, this will effectively remove the key. Access to restricted metamethods such as __gc or __metatable will cause an error. Setting __index or __newindex metamethods is also restricted because their values are cached for mlua internal usage.

pub fn contains(&self, key: impl AsRef<str>) -> Result<bool>

Checks whether the metatable contains a non-nil value for key.

pub fn pairs<V: FromLua<'lua>>(self) -> UserDataMetatablePairs<'lua, V>

Consumes this metatable and returns an iterator over the pairs of the metatable.

The pairs are wrapped in a Result, since they are lazily converted to V type.

Trait Implementations

impl<'lua> Clone for UserDataMetatable<'lua>

fn clone(&self) -> UserDataMetatable<'lua>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lua> Debug for UserDataMetatable<'lua>

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

Formats the value using the given formatter.