Merge pull request #88 from Fishrock123/doc-unstable-config

Fishrock123 · web-flow · commit 3993050157ac · 2021-05-19T11:44:23.000-07:00
docs: add "unstable-config" feature
diff --git a/Cargo.toml b/Cargo.toml
@@ -21,7 +21,7 @@ rustdoc-args = ["--cfg", "feature=\"docs\""]
 
 [features]
 default = ["h1_client", "native-tls"]
-docs = ["h1_client", "curl_client", "wasm_client", "hyper_client"]
+docs = ["h1_client", "curl_client", "wasm_client", "hyper_client", "unstable-config"]
 
 h1_client = ["async-h1", "async-std", "deadpool", "futures"]
 native_client = ["curl_client", "wasm_client"]
diff --git a/src/config.rs b/src/config.rs
@@ -4,6 +4,7 @@ use std::fmt::Debug;
 use std::time::Duration;
 
 /// Configuration for `HttpClient`s.
+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
 #[non_exhaustive]
 #[derive(Clone)]
 pub struct Config {
@@ -20,9 +21,11 @@ pub struct Config {
     /// Default: `Some(Duration::from_secs(60))`.
     pub timeout: Option<Duration>,
     /// TLS Configuration (Rustls)
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "h1_client")))]
     #[cfg(all(feature = "h1_client", feature = "rustls"))]
     pub tls_config: Option<std::sync::Arc<rustls_crate::ClientConfig>>,
     /// TLS Configuration (Native TLS)
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "h1_client")))]
     #[cfg(all(feature = "h1_client", feature = "native-tls", not(feature = "rustls")))]
     pub tls_config: Option<std::sync::Arc<async_native_tls::TlsConnector>>,
 }
@@ -91,6 +94,7 @@ impl Config {
     }
 
     /// Set TLS Configuration (Rustls)
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "h1_client")))]
     #[cfg(all(feature = "h1_client", feature = "rustls"))]
     pub fn set_tls_config(
         mut self,
@@ -100,6 +104,7 @@ impl Config {
         self
     }
     /// Set TLS Configuration (Native TLS)
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "h1_client")))]
     #[cfg(all(feature = "h1_client", feature = "native-tls", not(feature = "rustls")))]
     pub fn set_tls_config(
         mut self,
diff --git a/src/h1/mod.rs b/src/h1/mod.rs
@@ -1,4 +1,4 @@
-//! http-client implementation for async-h1, with connecton pooling ("Keep-Alive").
+//! http-client implementation for async-h1, with connection pooling ("Keep-Alive").
 
 #[cfg(feature = "unstable-config")]
 use std::convert::{Infallible, TryFrom};
@@ -272,6 +272,7 @@ impl HttpClient for H1Client {
         ))
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Override the existing configuration with new configuration.
     ///
@@ -282,13 +283,15 @@ impl HttpClient for H1Client {
         Ok(())
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Get the current configuration.
     fn config(&self) -> &Config {
         &*self.config
     }
 }
 
+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
 #[cfg(feature = "unstable-config")]
 impl TryFrom<Config> for H1Client {
     type Error = Infallible;
diff --git a/src/hyper.rs b/src/hyper.rs
@@ -92,6 +92,7 @@ impl HttpClient for HyperClient {
         Ok(res)
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Override the existing configuration with new configuration.
     ///
@@ -110,13 +111,15 @@ impl HttpClient for HyperClient {
         Ok(())
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Get the current configuration.
     fn config(&self) -> &Config {
         &self.config
     }
 }
 
+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
 #[cfg(feature = "unstable-config")]
 impl TryFrom<Config> for HyperClient {
     type Error = Infallible;
diff --git a/src/isahc.rs b/src/isahc.rs
@@ -75,6 +75,7 @@ impl HttpClient for IsahcClient {
         Ok(response)
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Override the existing configuration with new configuration.
     ///
@@ -98,13 +99,15 @@ impl HttpClient for IsahcClient {
         Ok(())
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     /// Get the current configuration.
     fn config(&self) -> &Config {
         &self.config
     }
 }
 
+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
 #[cfg(feature = "unstable-config")]
 impl TryFrom<Config> for IsahcClient {
     type Error = isahc::Error;
diff --git a/src/lib.rs b/src/lib.rs
@@ -21,24 +21,24 @@ pub use config::Config;
 #[cfg(not(feature = "unstable-config"))]
 type Config = ();
 
-#[cfg_attr(feature = "docs", doc(cfg(curl_client)))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "curl_client")))]
 #[cfg(all(feature = "curl_client", not(target_arch = "wasm32")))]
 pub mod isahc;
 
-#[cfg_attr(feature = "docs", doc(cfg(wasm_client)))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "wasm_client")))]
 #[cfg(all(feature = "wasm_client", target_arch = "wasm32"))]
 pub mod wasm;
 
-#[cfg_attr(feature = "docs", doc(cfg(native_client)))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "native_client")))]
 #[cfg(any(feature = "curl_client", feature = "wasm_client"))]
 pub mod native;
 
-#[cfg_attr(feature = "docs", doc(cfg(h1_client)))]
-#[cfg_attr(feature = "docs", doc(cfg(default)))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "h1_client")))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "default")))]
 #[cfg(any(feature = "h1_client", feature = "h1_client_rustls"))]
 pub mod h1;
 
-#[cfg_attr(feature = "docs", doc(cfg(hyper_client)))]
+#[cfg_attr(feature = "docs", doc(cfg(feature = "hyper_client")))]
 #[cfg(feature = "hyper_client")]
 pub mod hyper;
 
@@ -106,11 +106,13 @@ impl HttpClient for Box<dyn HttpClient> {
         self.as_ref().send(req).await
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     fn set_config(&mut self, config: Config) -> http_types::Result<()> {
         self.as_mut().set_config(config)
     }
 
+    #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]
     #[cfg(feature = "unstable-config")]
     fn config(&self) -> &Config {
         self.as_ref().config()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//! http-client implementation for async-h1, with connecton pooling ("Keep-Alive").`
	`1`	`+//! http-client implementation for async-h1, with connection pooling ("Keep-Alive").`
`2`	`2`
`3`	`3`	`#[cfg(feature = "unstable-config")]`
`4`	`4`	`use std::convert::{Infallible, TryFrom};`
`@@ -272,6 +272,7 @@ impl HttpClient for H1Client {`
`272`	`272`	`))`
`273`	`273`	`}`
`274`	`274`
	`275`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`275`	`276`	`#[cfg(feature = "unstable-config")]`
`276`	`277`	`/// Override the existing configuration with new configuration.`
`277`	`278`	`///`
`@@ -282,13 +283,15 @@ impl HttpClient for H1Client {`
`282`	`283`	`Ok(())`
`283`	`284`	`}`
`284`	`285`
	`286`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`285`	`287`	`#[cfg(feature = "unstable-config")]`
`286`	`288`	`/// Get the current configuration.`
`287`	`289`	`fn config(&self) -> &Config {`
`288`	`290`	`&*self.config`
`289`	`291`	`}`
`290`	`292`	`}`
`291`	`293`
	`294`	`+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`292`	`295`	`#[cfg(feature = "unstable-config")]`
`293`	`296`	`impl TryFrom<Config> for H1Client {`
`294`	`297`	`type Error = Infallible;`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@ impl HttpClient for HyperClient {`
`92`	`92`	`Ok(res)`
`93`	`93`	`}`
`94`	`94`
	`95`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`95`	`96`	`#[cfg(feature = "unstable-config")]`
`96`	`97`	`/// Override the existing configuration with new configuration.`
`97`	`98`	`///`
`@@ -110,13 +111,15 @@ impl HttpClient for HyperClient {`
`110`	`111`	`Ok(())`
`111`	`112`	`}`
`112`	`113`
	`114`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`113`	`115`	`#[cfg(feature = "unstable-config")]`
`114`	`116`	`/// Get the current configuration.`
`115`	`117`	`fn config(&self) -> &Config {`
`116`	`118`	`&self.config`
`117`	`119`	`}`
`118`	`120`	`}`
`119`	`121`
	`122`	`+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`120`	`123`	`#[cfg(feature = "unstable-config")]`
`121`	`124`	`impl TryFrom<Config> for HyperClient {`
`122`	`125`	`type Error = Infallible;`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ impl HttpClient for IsahcClient {`
`75`	`75`	`Ok(response)`
`76`	`76`	`}`
`77`	`77`
	`78`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`78`	`79`	`#[cfg(feature = "unstable-config")]`
`79`	`80`	`/// Override the existing configuration with new configuration.`
`80`	`81`	`///`
`@@ -98,13 +99,15 @@ impl HttpClient for IsahcClient {`
`98`	`99`	`Ok(())`
`99`	`100`	`}`
`100`	`101`
	`102`	`+ #[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`101`	`103`	`#[cfg(feature = "unstable-config")]`
`102`	`104`	`/// Get the current configuration.`
`103`	`105`	`fn config(&self) -> &Config {`
`104`	`106`	`&self.config`
`105`	`107`	`}`
`106`	`108`	`}`
`107`	`109`
	`110`	`+#[cfg_attr(feature = "docs", doc(cfg(feature = "unstable-config")))]`
`108`	`111`	`#[cfg(feature = "unstable-config")]`
`109`	`112`	`impl TryFrom<Config> for IsahcClient {`
`110`	`113`	`type Error = isahc::Error;`