Struct mlua::RegistryKey

pub struct RegistryKey { /* private fields */ }

An auto generated key into the Lua registry.

This is a handle to a value stored inside the Lua registry. It is not automatically garbage collected on Drop, but it can be removed with Lua::remove_registry_value, and instances not manually removed can be garbage collected with Lua::expire_registry_values.

Be warned, If you place this into Lua via a UserData type or a rust callback, it is very easy to accidentally cause reference cycles that the Lua garbage collector cannot resolve. Instead of placing a RegistryKey into a UserData type, prefer instead to use AnyUserData::set_user_value / AnyUserData::get_user_value.

Trait Implementations

impl Debug for RegistryKey

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

Formats the value using the given formatter.

impl Drop for RegistryKey

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for RegistryKey

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<RegistryKey> for RegistryKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RegistryKey