build: move away from "use-" feature naming

Introduce simpler feature names "openssl", "rustls",
and "rustls-ring". The original "use-" style names
are still available for backwards compatibility.

Author: ValuedMammal

Cargo.toml

@@ -38,10 +38,15 @@ libc = { version = "0.2", optional = true }
 winapi = { version="0.3.9", features=["winsock2"], optional = true }
 
 [features]
-default = ["proxy", "use-rustls"]
+default = ["proxy", "rustls"]
 minimal = []
 debug-calls = []
 proxy = ["byteorder", "winapi", "libc"]
-use-rustls = ["webpki-roots", "rustls/default"]
-use-rustls-ring = ["webpki-roots", "rustls/ring", "rustls/logging", "rustls/std", "rustls/tls12"]
+rustls = ["webpki-roots", "dep:rustls", "rustls/default"]
+rustls-ring = ["webpki-roots", "dep:rustls", "rustls/ring", "rustls/logging", "rustls/std", "rustls/tls12"]
+openssl = ["dep:openssl"]
+
+# Old feature names
+use-rustls = ["rustls"]
+use-rustls-ring = ["rustls-ring"]
 use-openssl = ["openssl"]

src/lib.rs

@@ -22,14 +22,14 @@
 pub extern crate bitcoin;
 extern crate core;
 extern crate log;
-#[cfg(feature = "use-openssl")]
+#[cfg(feature = "openssl")]
 extern crate openssl;
-#[cfg(any(feature = "use-rustls", feature = "use-rustls-ring"))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 extern crate rustls;
 extern crate serde;
 extern crate serde_json;
 
-#[cfg(any(feature = "use-rustls", feature = "use-rustls-ring"))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 extern crate webpki_roots;
 
 #[cfg(feature = "proxy")]
@@ -46,11 +46,7 @@ pub mod socks;
 mod api;
 mod batch;
 
-#[cfg(any(
-    feature = "use-openssl",
-    feature = "use-rustls",
-    feature = "use-rustls-ring",
-))]
+#[cfg(any(feature = "openssl", feature = "rustls", feature = "rustls-ring"))]
 pub mod client;
 
 mod config;
@@ -62,11 +58,7 @@ pub mod utils;
 
 pub use api::ElectrumApi;
 pub use batch::Batch;
-#[cfg(any(
-    feature = "use-openssl",
-    feature = "use-rustls",
-    feature = "use-rustls-ring",
-))]
+#[cfg(any(feature = "openssl", feature = "rustls", feature = "rustls-ring"))]
 pub use client::*;
 pub use config::{Config, ConfigBuilder, Socks5Config};
 pub use types::*;

src/raw_client.rs

@@ -19,10 +19,10 @@ use bitcoin::consensus::encode::deserialize;
 use bitcoin::hex::{DisplayHex, FromHex};
 use bitcoin::{Script, Txid};
 
-#[cfg(feature = "use-openssl")]
+#[cfg(feature = "openssl")]
 use openssl::ssl::{SslConnector, SslMethod, SslStream, SslVerifyMode};
 
-#[cfg(any(feature = "use-rustls", feature = "use-rustls-ring"))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 #[allow(unused_imports)]
 use rustls::{
     pki_types::ServerName,
@@ -222,10 +222,10 @@ fn connect_with_total_timeout<A: ToSocketAddrs>(
     Err(Error::AllAttemptsErrored(errors))
 }
 
-#[cfg(feature = "use-openssl")]
+#[cfg(feature = "openssl")]
 /// Transport type used to establish an OpenSSL TLS encrypted/authenticated connection with the server
 pub type ElectrumSslStream = SslStream<TcpStream>;
-#[cfg(feature = "use-openssl")]
+#[cfg(feature = "openssl")]
 impl RawClient<ElectrumSslStream> {
     /// Creates a new SSL client and tries to connect to `socket_addr`. Optionally, if
     /// `validate_domain` is `true`, validate the server's certificate.
@@ -283,7 +283,7 @@ impl RawClient<ElectrumSslStream> {
     }
 }
 
-#[cfg(any(feature = "use-rustls", feature = "use-rustls-ring"))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 #[allow(unused)]
 mod danger {
     use crate::raw_client::ServerName;
@@ -338,14 +338,14 @@ mod danger {
 }
 
 #[cfg(all(
-    any(feature = "use-rustls", feature = "use-rustls-ring"),
-    not(feature = "use-openssl")
+    any(feature = "rustls", feature = "rustls-ring"),
+    not(feature = "openssl")
 ))]
 /// Transport type used to establish a Rustls TLS encrypted/authenticated connection with the server
 pub type ElectrumSslStream = StreamOwned<ClientConnection, TcpStream>;
 #[cfg(all(
-    any(feature = "use-rustls", feature = "use-rustls-ring"),
-    not(feature = "use-openssl")
+    any(feature = "rustls", feature = "rustls-ring"),
+    not(feature = "openssl")
 ))]
 impl RawClient<ElectrumSslStream> {
     /// Creates a new SSL client and tries to connect to `socket_addr`. Optionally, if
@@ -384,9 +384,9 @@ impl RawClient<ElectrumSslStream> {
         validate_domain: bool,
         tcp_stream: TcpStream,
     ) -> Result<Self, Error> {
-        #[cfg(not(feature = "use-rustls-ring"))]
+        #[cfg(not(feature = "rustls-ring"))]
         let crypto_provider = rustls::crypto::aws_lc_rs::default_provider();
-        #[cfg(feature = "use-rustls-ring")]
+        #[cfg(feature = "rustls-ring")]
         let crypto_provider = rustls::crypto::ring::default_provider();
 
         // We install a crypto provider depending on the set feature.
@@ -468,11 +468,7 @@ impl RawClient<ElectrumProxyStream> {
     }
 
     #[cfg(all(
-        any(
-            feature = "use-openssl",
-            feature = "use-rustls",
-            feature = "use-rustls-ring",
-        ),
+        any(feature = "openssl", feature = "rustls", feature = "rustls-ring",),
         feature = "proxy",
     ))]
     /// Creates a new TLS client that connects to `target_addr` using `proxy_addr` as a socks proxy

src/types.rs

@@ -326,14 +326,14 @@ pub enum Error {
     CouldntLockReader,
     /// Broken IPC communication channel: the other thread probably has exited
     Mpsc,
-    #[cfg(any(feature = "use-rustls", feature = "use-rustls-ring"))]
+    #[cfg(any(feature = "rustls", feature = "rustls-ring"))]
     /// Could not create a rustls client connection
     CouldNotCreateConnection(rustls::Error),
 
-    #[cfg(feature = "use-openssl")]
+    #[cfg(feature = "openssl")]
     /// Invalid OpenSSL method used
     InvalidSslMethod(openssl::error::ErrorStack),
-    #[cfg(feature = "use-openssl")]
+    #[cfg(feature = "openssl")]
     /// SSL Handshake failed with the server
     SslHandshakeError(openssl::ssl::HandshakeError<std::net::TcpStream>),
 }
@@ -346,13 +346,13 @@ impl Display for Error {
             Error::Hex(e) => Display::fmt(e, f),
             Error::Bitcoin(e) => Display::fmt(e, f),
             Error::SharedIOError(e) => Display::fmt(e, f),
-            #[cfg(feature = "use-openssl")]
+            #[cfg(feature = "openssl")]
             Error::SslHandshakeError(e) => Display::fmt(e, f),
-            #[cfg(feature = "use-openssl")]
+            #[cfg(feature = "openssl")]
             Error::InvalidSslMethod(e) => Display::fmt(e, f),
             #[cfg(any(
-                feature = "use-rustls",
-                feature = "use-rustls-ring",
+                feature = "rustls",
+                feature = "rustls-ring",
             ))]
             Error::CouldNotCreateConnection(e) => Display::fmt(e, f),