Struct LuaRegistryKey

pub struct LuaRegistryKey { /* 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 easy to accidentally cause reference cycles that the Lua garbage collector cannot resolve. Instead of placing a RegistryKey into a UserData type, consider to use AnyUserData::set_user_value.

Implementations

impl RegistryKey

pub fn id(&self) -> i32

Returns the underlying Lua reference of this RegistryKey

Trait Implementations

impl Debug for RegistryKey

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

Formats the value using the given formatter.

impl Drop for RegistryKey

fn drop(&mut self)

Executes the destructor for this type.

impl FromLua for RegistryKey

fn from_lua(value: Value, lua: &Lua) -> Result<RegistryKey, Error>

Performs the conversion.

impl Hash for RegistryKey

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoLua for &RegistryKey

fn into_lua(self, lua: &Lua) -> Result<Value, Error>

Performs the conversion.

impl IntoLua for RegistryKey

fn into_lua(self, lua: &Lua) -> Result<Value, Error>

Performs the conversion.

impl PartialEq for RegistryKey

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