Move utilities and combinators to a separate package

Hyper works with all combinators removed.

Removing methods from the trait is a breaking change, but it is possible
to do the semver trick (release 0.5, then release 0.4.x with a
dependency on the 0.5 trait) to not split the ecosystem.

Addresses #52.

Author: g2p

.github/workflows/CI.yml

@@ -27,4 +27,4 @@ jobs:
       - name: Install Rust
         run: rustup update ${{ matrix.rust }} && rustup default ${{ matrix.rust }}
       - name: Run tests
-        run: cargo test
+        run: cargo test --workspace

Cargo.toml

@@ -24,11 +24,11 @@ Trait representing an asynchronous, streaming, HTTP request or response body.
 """
 keywords = ["http"]
 categories = ["web-programming"]
+resolver = "2"
+
+[workspace]
+members = ["util"]
 
 [dependencies]
 bytes = "1"
 http = "0.2"
-pin-project-lite = "0.2"
-
-[dev-dependencies]
-tokio = { version = "1", features = ["macros", "rt"] }

src/lib.rs

@@ -13,19 +13,12 @@
 //!
 //! [`Body`]: trait.Body.html
 
-mod empty;
-mod full;
 mod next;
 mod size_hint;
 
-pub mod combinators;
-
-pub use self::empty::Empty;
-pub use self::full::Full;
 pub use self::next::{Data, Trailers};
 pub use self::size_hint::SizeHint;
 
-use self::combinators::{BoxBody, MapData, MapErr, UnsyncBoxBody};
 use bytes::Buf;
 use http::HeaderMap;
 use std::ops;
@@ -95,41 +88,6 @@ pub trait Body {
     {
         Trailers(self)
     }
-
-    /// Maps this body's data value to a different value.
-    fn map_data<F, B>(self, f: F) -> MapData<Self, F>
-    where
-        Self: Sized,
-        F: FnMut(Self::Data) -> B,
-        B: Buf,
-    {
-        MapData::new(self, f)
-    }
-
-    /// Maps this body's error value to a different value.
-    fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
-    where
-        Self: Sized,
-        F: FnMut(Self::Error) -> E,
-    {
-        MapErr::new(self, f)
-    }
-
-    /// Turn this body into a boxed trait object.
-    fn boxed(self) -> BoxBody<Self::Data, Self::Error>
-    where
-        Self: Sized + Send + Sync + 'static,
-    {
-        BoxBody::new(self)
-    }
-
-    /// Turn this body into a boxed trait object that is !Sync.
-    fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
-    where
-        Self: Sized + Send + 'static,
-    {
-        UnsyncBoxBody::new(self)
-    }
 }
 
 impl<T: Body + Unpin + ?Sized> Body for &mut T {

util/Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "http-body-util"
+version = "0.4.4"
+authors = [
+  "Carl Lerche <[email protected]>",
+  "Lucio Franco <[email protected]>",
+  "Sean McArthur <[email protected]>",
+]
+edition = "2018"
+readme = "README.md"
+documentation = "https://docs.rs/http-body-util"
+repository = "https://github.com/hyperium/http-body"
+license = "MIT"
+description = """
+Combinators and adapters for HTTP request or response bodies.
+"""
+keywords = ["http"]
+categories = ["web-programming"]
+resolver = "2"
+
+[dependencies]
+bytes = "1"
+http = "0.2"
+http-body = { path = ".." }
+pin-project-lite = "0.2"
+
+[dev-dependencies]
+tokio = { version = "1", features = ["macros", "rt"] }

src/combinators/box_body.rs renamed to util/src/combinators/box_body.rs

@@ -1,4 +1,6 @@
-use crate::Body;
+use crate::BodyExt as _;
+
+use http_body::{Body, SizeHint};
 use bytes::Buf;
 use std::{
     fmt,
@@ -60,7 +62,7 @@ where
         self.inner.is_end_stream()
     }
 
-    fn size_hint(&self) -> crate::SizeHint {
+    fn size_hint(&self) -> SizeHint {
         self.inner.size_hint()
     }
 }
@@ -119,7 +121,7 @@ where
         self.inner.is_end_stream()
     }
 
-    fn size_hint(&self) -> crate::SizeHint {
+    fn size_hint(&self) -> SizeHint {
         self.inner.size_hint()
     }
 }

src/combinators/map_data.rs renamed to util/src/combinators/map_data.rs

@@ -1,4 +1,4 @@
-use crate::Body;
+use http_body::Body;
 use bytes::Buf;
 use pin_project_lite::pin_project;
 use std::{

src/combinators/map_err.rs renamed to util/src/combinators/map_err.rs

@@ -1,4 +1,4 @@
-use crate::Body;
+use http_body::{Body, SizeHint};
 use pin_project_lite::pin_project;
 use std::{
     any::type_name,
@@ -79,7 +79,7 @@ where
         self.inner.is_end_stream()
     }
 
-    fn size_hint(&self) -> crate::SizeHint {
+    fn size_hint(&self) -> SizeHint {
         self.inner.size_hint()
     }
 }

src/combinators/mod.rs renamed to util/src/combinators/mod.rs

@@ -1,4 +1,4 @@
-use super::{Body, SizeHint};
+use http_body::{Body, SizeHint};
 use bytes::Buf;
 use http::HeaderMap;
 use std::{

src/empty.rs renamed to util/src/empty.rs

@@ -1,4 +1,4 @@
-use crate::{Body, SizeHint};
+use http_body::{Body, SizeHint};
 use bytes::{Buf, Bytes};
 use http::HeaderMap;
 use pin_project_lite::pin_project;

src/full.rs renamed to util/src/full.rs

@@ -0,0 +1,61 @@
+#![deny(
+    missing_debug_implementations,
+    missing_docs,
+    unreachable_pub,
+    broken_intra_doc_links
+)]
+#![cfg_attr(test, deny(warnings))]
+
+//! Utilities for [`http_body::Body`].
+//!
+//! [`BodyExt`] adds extensions to the common trait.
+//!
+//! [`Empty`] and [`Full`] provide simple implementations.
+
+pub mod combinators;
+mod empty;
+mod full;
+
+pub use self::empty::Empty;
+pub use self::full::Full;
+use self::combinators::{BoxBody, MapData, MapErr, UnsyncBoxBody};
+
+/// An extension trait for [`http_body::Body`] adding various combinators and adapters
+pub trait BodyExt: http_body::Body {
+    /// Maps this body's data value to a different value.
+    fn map_data<F, B>(self, f: F) -> MapData<Self, F>
+    where
+        Self: Sized,
+        F: FnMut(Self::Data) -> B,
+        B: bytes::Buf,
+    {
+        MapData::new(self, f)
+    }
+
+    /// Maps this body's error value to a different value.
+    fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
+    where
+        Self: Sized,
+        F: FnMut(Self::Error) -> E,
+    {
+        MapErr::new(self, f)
+    }
+
+    /// Turn this body into a boxed trait object.
+    fn boxed(self) -> BoxBody<Self::Data, Self::Error>
+    where
+        Self: Sized + Send + Sync + 'static,
+    {
+        BoxBody::new(self)
+    }
+
+    /// Turn this body into a boxed trait object that is !Sync.
+    fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
+    where
+        Self: Sized + Send + 'static,
+    {
+        UnsyncBoxBody::new(self)
+    }
+}
+
+impl<T: ?Sized> BodyExt for T where T: http_body::Body {}