chore(tonic): Deprecate API when they only return None

hyperium · Sep 14, 2023 · 86a7dce · 86a7dce
1 parent 6af8d5c
commit 86a7dce
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/tonic/src/request.rs b/tonic/src/request.rs
@@ -207,6 +207,13 @@ impl<T> Request<T> {
     /// This will return `None` if the `IO` type used
     /// does not implement `Connected` or when using a unix domain socket.
     /// This currently only works on the server side.
+    #[cfg_attr(
+        not(feature = "transport"),
+        deprecated(
+            since = "0.10.1",
+            note = "`remote_addr` only returns `None` without transport feature. This API will require transport feature.",
+        )
+    )]
     pub fn local_addr(&self) -> Option<SocketAddr> {
         #[cfg(feature = "transport")]
         {
@@ -241,6 +248,13 @@ impl<T> Request<T> {
     /// This will return `None` if the `IO` type used
     /// does not implement `Connected` or when using a unix domain socket.
     /// This currently only works on the server side.
+    #[cfg_attr(
+        not(feature = "transport"),
+        deprecated(
+            since = "0.10.1",
+            note = "`remote_addr` only returns `None` without transport feature. This API will require transport feature.",
+        )
+    )]
     pub fn remote_addr(&self) -> Option<SocketAddr> {
         #[cfg(feature = "transport")]
         {
@@ -277,6 +291,13 @@ impl<T> Request<T> {
     /// `Some` on the server side of the `transport` server with
     /// TLS enabled connections.
     #[cfg(feature = "transport")]
+    #[cfg_attr(
+        all(feature = "transport", not(feature = "tls")),
+        deprecated(
+            since = "0.10.1",
+            note = "`peer_certs` only returns `None` without tls feature. This API will require tls feature.",
+        )
+    )]
     #[cfg_attr(docsrs, doc(cfg(feature = "transport")))]
     pub fn peer_certs(&self) -> Option<Arc<Vec<Certificate>>> {
         #[cfg(feature = "tls")]

diff --git a/tonic/src/transport/tls.rs b/tonic/src/transport/tls.rs
@@ -1,4 +1,11 @@
 /// Represents a X509 certificate.
+#[cfg_attr(
+    not(feature = "tls"),
+    deprecated(
+        since = "0.10.1",
+        note = "`Certificate` is used only by deprecated API without tls feature.",
+    )
+)]
 #[derive(Debug, Clone)]
 pub struct Certificate {
     pub(crate) pem: Vec<u8>,
@@ -13,6 +20,13 @@ pub struct Identity {
     pub(crate) key: Vec<u8>,
 }
 
+#[cfg_attr(
+    not(feature = "tls"),
+    deprecated(
+        since = "0.10.1",
+        note = "`Certificate` is used only by deprecated API without tls feature.",
+    )
+)]
 impl Certificate {
     /// Parse a PEM encoded X509 Certificate.
     ///
@@ -38,6 +52,13 @@ impl Certificate {
     }
 }
 
+#[cfg_attr(
+    not(feature = "tls"),
+    deprecated(
+        since = "0.10.1",
+        note = "`Certificate` is used only by deprecated API without tls feature.",
+    )
+)]
 impl AsRef<[u8]> for Certificate {
     fn as_ref(&self) -> &[u8] {
         self.pem.as_ref()