Struct UserDataMetatable

pub struct UserDataMetatable(/* private fields */);

Handle to a AnyUserData metatable.

Implementations

impl UserDataMetatable

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

where V: FromLua,

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( &self, key: impl AsRef<str>, value: impl IntoLua, ) -> Result<(), Error>

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, Error>

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

pub fn pairs<V>(&self) -> UserDataMetatablePairs<'_, V>

where V: FromLua,

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 Clone for UserDataMetatable

fn clone(&self) -> UserDataMetatable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserDataMetatable

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

Formats the value using the given formatter.