Merge pull request #109 from madsmtm/deprecated-ivar-methods

(Re)add deprecated ivar methods
madsmtm · Jan 6, 2022 · fd5ce60 · fd5ce60
2 parents 75a1a08 + ad53feb
commit fd5ce60
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/objc2/CHANGELOG.md b/objc2/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased - YYYY-MM-DD
 
+### Added
+* Added deprecated `Object::get_ivar` and `Object::get_mut_ivar` to make
+  upgrading easier.
+
 
 ## 0.3.0-alpha.6 - 2022-01-03
 

diff --git a/objc2/src/runtime.rs b/objc2/src/runtime.rs
@@ -557,6 +557,13 @@ impl Object {
         unsafe { &*ptr }
     }
 
+    /// Use [`ivar`](`Self::ivar`) instead.
+    #[deprecated = "Use `Object::ivar` instead."]
+    pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T {
+        // SAFETY: Upheld by caller
+        unsafe { self.ivar(name) }
+    }
+
     /// Returns a mutable reference to the ivar with the given name.
     ///
     /// # Panics
@@ -577,6 +584,13 @@ impl Object {
         unsafe { &mut *ptr }
     }
 
+    /// Use [`ivar_mut`](`Self::ivar_mut`) instead.
+    #[deprecated = "Use `Object::ivar_mut` instead."]
+    pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T {
+        // SAFETY: Upheld by caller
+        unsafe { self.ivar_mut(name) }
+    }
+
     /// Sets the value of the ivar with the given name.
     ///
     /// # Panics