Merge pull request #94 from http-rs/client-server-traits

Add Client and Server traits

Author: yoshuawuyts

Cargo.toml

@@ -11,8 +11,14 @@ authors = ["Yoshua Wuyts <[email protected]>"]
 readme = "README.md"
 edition = "2018"
 
+[package.metadata.docs.rs]
+features = ["docs"]
+rustdoc-args = ["--cfg", "feature=\"docs\""]
+
 [features]
 default = []
+docs = ["unstable"]
+unstable = []
 hyperium_http = ["http"]
 
 [dependencies]

src/client.rs

@@ -0,0 +1,15 @@
+use std::fmt::Debug;
+use std::future::Future;
+use std::pin::Pin;
+
+use crate::{Request, Response, Result};
+
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a + Send>>;
+
+/// An HTTP client.
+#[cfg(feature = "unstable")]
+#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
+pub trait Client: Debug + Unpin + Send + Sync + Clone + 'static {
+    /// Send an HTTP request from the client.
+    fn send_req(&self, req: Request) -> BoxFuture<'static, Result<Response>>;
+}

src/lib.rs

@@ -95,8 +95,9 @@
 
 #![forbid(rust_2018_idioms)]
 #![deny(missing_debug_implementations, nonstandard_style)]
-#![warn(missing_docs, missing_doc_code_examples, unreachable_pub)]
+#![warn(missing_docs, unreachable_pub)]
 #![cfg_attr(test, deny(warnings))]
+#![cfg_attr(feature = "docs", feature(doc_cfg))]
 
 /// HTTP cookies.
 pub mod cookies {
@@ -111,6 +112,9 @@ pub mod url {
     };
 }
 
+#[macro_use]
+mod utils;
+
 pub mod headers;
 pub mod mime;
 
@@ -125,6 +129,14 @@ mod status_code;
 mod type_map;
 mod version;
 
+cfg_unstable! {
+    mod client;
+    mod server;
+
+    pub use client::Client;
+    pub use server::Server;
+}
+
 pub use body::Body;
 pub use error::{Error, Result};
 pub use method::Method;

src/server.rs

@@ -0,0 +1,15 @@
+use std::fmt::Debug;
+use std::future::Future;
+use std::pin::Pin;
+
+use crate::{Request, Response, Result};
+
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a + Send>>;
+
+/// An HTTP server.
+#[cfg(feature = "unstable")]
+#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
+pub trait Server: Debug + Unpin + Send + Sync + Clone + 'static {
+    /// Receive an HTTP request on the server.
+    fn recv_req(&self, req: Request) -> BoxFuture<'static, Result<Response>>;
+}

src/utils.rs

@@ -0,0 +1,11 @@
+/// Declares unstable items.
+#[doc(hidden)]
+macro_rules! cfg_unstable {
+    ($($item:item)*) => {
+        $(
+            #[cfg(feature = "unstable")]
+            #[cfg_attr(feature = "docs", doc(cfg(unstable)))]
+            $item
+        )*
+    }
+}