🗑️ zb: Deprecate connection::Builder::auth_mechansims

In favor of `auth_mechansim`. This is in preparation for dbus2#731, when we will remove this method entirely.
zeenix · Apr 29, 2024 · 8b1c4ed · 8b1c4ed
1 parent 94b38b9
commit 8b1c4ed
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/zbus/src/blocking/connection/builder.rs b/zbus/src/blocking/connection/builder.rs
@@ -96,7 +96,9 @@ impl<'a> Builder<'a> {
     }
 
     /// Specify the mechanisms to use during authentication.
+    #[deprecated(since = "4.1.3", note = "Use `auth_mechanism` instead.")]
     pub fn auth_mechanisms(self, auth_mechanisms: &[AuthMechanism]) -> Self {
+        #[allow(deprecated)]
         Self(self.0.auth_mechanisms(auth_mechanisms))
     }
 

diff --git a/zbus/src/connection/builder.rs b/zbus/src/connection/builder.rs
@@ -185,10 +185,12 @@ impl<'a> Builder<'a> {
 
     /// Specify the mechanism to use during authentication.
     pub fn auth_mechanism(self, auth_mechanism: AuthMechanism) -> Self {
+        #[allow(deprecated)]
         self.auth_mechanisms(&[auth_mechanism])
     }
 
     /// Specify the mechanisms to use during authentication.
+    #[deprecated(since = "4.1.3", note = "Use `auth_mechanism` instead.")]
     pub fn auth_mechanisms(mut self, auth_mechanisms: &[AuthMechanism]) -> Self {
         self.auth_mechanisms = Some(VecDeque::from(auth_mechanisms.to_vec()));
 

diff --git a/zbus/src/connection/mod.rs b/zbus/src/connection/mod.rs
@@ -1472,7 +1472,7 @@ mod p2p_tests {
                     .server(guid)
                     .unwrap()
                     .p2p()
-                    .auth_mechanisms(&[AuthMechanism::Anonymous]),
+                    .auth_mechanism(AuthMechanism::Anonymous),
                 Builder::tcp_stream(p1).p2p(),
             )
         };
@@ -1489,7 +1489,7 @@ mod p2p_tests {
                     .server(guid)
                     .unwrap()
                     .p2p()
-                    .auth_mechanisms(&[AuthMechanism::Anonymous]),
+                    .auth_mechanism(AuthMechanism::Anonymous),
                 Builder::tcp_stream(p1).p2p(),
             )
         };
@@ -1568,7 +1568,7 @@ mod p2p_tests {
                 .server(guid)
                 .unwrap()
                 .p2p()
-                .auth_mechanisms(&[AuthMechanism::Anonymous])
+                .auth_mechanism(AuthMechanism::Anonymous)
                 .build(),
             Builder::vsock_stream(client).p2p().build(),
         )
@@ -1587,7 +1587,7 @@ mod p2p_tests {
                 .server(guid)
                 .unwrap()
                 .p2p()
-                .auth_mechanisms(&[AuthMechanism::Anonymous])
+                .auth_mechanism(AuthMechanism::Anonymous)
                 .build(),
             Builder::vsock_stream(client).p2p().build(),
         )
@@ -1655,7 +1655,7 @@ mod p2p_tests {
             .server(guid)
             .unwrap()
             .p2p()
-            .auth_mechanisms(&[AuthMechanism::Cookie])
+            .auth_mechanism(AuthMechanism::Cookie)
             .cookie_context(cookie_context)
             .unwrap();
         if let Some(cookie_id) = cookie_id {