Rename get_metatable to metatable for Table/AnyUserData types

Author: khvzak

src/table.rs

@@ -227,12 +227,12 @@ impl Table {
         // Compare using __eq metamethod if exists
         // First, check the self for the metamethod.
         // If self does not define it, then check the other table.
-        if let Some(mt) = self.get_metatable() {
+        if let Some(mt) = self.metatable() {
             if mt.contains_key("__eq")? {
                 return mt.get::<Function>("__eq")?.call((self, other));
             }
         }
-        if let Some(mt) = other.get_metatable() {
+        if let Some(mt) = other.metatable() {
             if mt.contains_key("__eq")? {
                 return mt.get::<Function>("__eq")?.call((self, other));
             }
@@ -493,7 +493,7 @@ impl Table {
     /// Returns a reference to the metatable of this table, or `None` if no metatable is set.
     ///
     /// Unlike the `getmetatable` Lua function, this method ignores the `__metatable` field.
-    pub fn get_metatable(&self) -> Option<Table> {
+    pub fn metatable(&self) -> Option<Table> {
         let lua = self.0.lua.lock();
         let state = lua.state();
         unsafe {
@@ -509,6 +509,12 @@ impl Table {
         }
     }
 
+    #[doc(hidden)]
+    #[deprecated(since = "0.10.0", note = "please use `metatable` instead")]
+    pub fn get_metatable(&self) -> Option<Table> {
+        self.metatable()
+    }
+
     /// Sets or removes the metatable of this table.
     ///
     /// If `metatable` is `None`, the metatable is removed (if no metatable is set, this does

src/userdata.rs

@@ -900,10 +900,16 @@ impl AnyUserData {
     ///
     /// [`UserDataMetatable`]: crate::UserDataMetatable
     #[inline]
-    pub fn get_metatable(&self) -> Result<UserDataMetatable> {
+    pub fn metatable(&self) -> Result<UserDataMetatable> {
         self.get_raw_metatable().map(UserDataMetatable)
     }
 
+    #[doc(hidden)]
+    #[deprecated(since = "0.10.0", note = "please use `metatable` instead")]
+    pub fn get_metatable(&self) -> Result<UserDataMetatable> {
+        self.metatable()
+    }
+
     fn get_raw_metatable(&self) -> Result<Table> {
         let lua = self.0.lua.lock();
         let state = lua.state();

tests/scope.rs

@@ -300,7 +300,7 @@ fn test_scope_userdata_drop() -> Result<()> {
         Err(Error::UserDataDestructed) => {}
         Err(err) => panic!("improper borrow error for destructed userdata: {err:?}"),
     }
-    match ud.get_metatable() {
+    match ud.metatable() {
         Ok(_) => panic!("successful metatable retrieval of destructed userdata"),
         Err(Error::UserDataDestructed) => {}
         Err(err) => panic!("improper metatable error for destructed userdata: {err:?}"),

tests/table.rs

@@ -181,7 +181,7 @@ fn test_table_clear() -> Result<()> {
     assert_eq!(t2.raw_len(), 0);
     assert!(t2.is_empty());
     assert_eq!(t2.raw_get::<Value>("a")?, Value::Nil);
-    assert_ne!(t2.get_metatable(), None);
+    assert_ne!(t2.metatable(), None);
 
     Ok(())
 }

tests/userdata.rs

@@ -198,10 +198,10 @@ fn test_metamethods() -> Result<()> {
     assert!(userdata2.equals(userdata3)?);
 
     let userdata1: AnyUserData = globals.get("userdata1")?;
-    assert!(userdata1.get_metatable()?.contains(MetaMethod::Add)?);
-    assert!(userdata1.get_metatable()?.contains(MetaMethod::Sub)?);
-    assert!(userdata1.get_metatable()?.contains(MetaMethod::Index)?);
-    assert!(!userdata1.get_metatable()?.contains(MetaMethod::Pow)?);
+    assert!(userdata1.metatable()?.contains(MetaMethod::Add)?);
+    assert!(userdata1.metatable()?.contains(MetaMethod::Sub)?);
+    assert!(userdata1.metatable()?.contains(MetaMethod::Index)?);
+    assert!(!userdata1.metatable()?.contains(MetaMethod::Pow)?);
 
     Ok(())
 }
@@ -565,7 +565,7 @@ fn test_metatable() -> Result<()> {
     impl UserData for MyUserData {
         fn add_methods<M: UserDataMethods<Self>>(methods: &mut M) {
             methods.add_function("my_type_name", |_, data: AnyUserData| {
-                let metatable = data.get_metatable()?;
+                let metatable = data.metatable()?;
                 metatable.get::<String>(MetaMethod::Type)
             });
         }
@@ -583,7 +583,7 @@ fn test_metatable() -> Result<()> {
     lua.load(r#"assert(typeof(ud) == "MyUserData")"#).exec()?;
 
     let ud: AnyUserData = globals.get("ud")?;
-    let metatable = ud.get_metatable()?;
+    let metatable = ud.metatable()?;
 
     match metatable.get::<Value>("__gc") {
         Ok(_) => panic!("expected MetaMethodRestricted, got no error"),
@@ -629,7 +629,7 @@ fn test_metatable() -> Result<()> {
     }
 
     let ud = lua.create_userdata(MyUserData3)?;
-    let metatable = ud.get_metatable()?;
+    let metatable = ud.metatable()?;
     assert_eq!(metatable.get::<String>(MetaMethod::Type)?.to_str()?, "CustomName");
 
     Ok(())