Skip to content

Commit 43412a9

Browse files
jplatteseanmonstar
authored andcommitted
refactor(lib): Switch from pin-project to pin-project-lite
1 parent 9dff004 commit 43412a9

File tree

14 files changed

+336
-255
lines changed

14 files changed

+336
-255
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ httparse = "1.0"
3434
h2 = { version = "0.3", optional = true }
3535
itoa = "0.4.1"
3636
tracing = { version = "0.1", default-features = false, features = ["std"] }
37-
pin-project = "1.0"
37+
pin-project-lite = "0.2.4"
3838
tower-service = "0.3"
3939
tokio = { version = "1", features = ["sync"] }
4040
want = "0.3"

src/client/conn.rs

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ use std::time::Duration;
5656

5757
use bytes::Bytes;
5858
use futures_util::future::{self, Either, FutureExt as _};
59-
use pin_project::pin_project;
59+
use pin_project_lite::pin_project;
6060
use tokio::io::{AsyncRead, AsyncWrite};
6161
use tower_service::Service;
6262

@@ -75,15 +75,23 @@ use crate::{Body, Request, Response};
7575
#[cfg(feature = "http1")]
7676
type Http1Dispatcher<T, B, R> = proto::dispatch::Dispatcher<proto::dispatch::Client<B>, B, T, R>;
7777

78-
#[pin_project(project = ProtoClientProj)]
79-
enum ProtoClient<T, B>
80-
where
81-
B: HttpBody,
82-
{
83-
#[cfg(feature = "http1")]
84-
H1(#[pin] Http1Dispatcher<T, B, proto::h1::ClientTransaction>),
85-
#[cfg(feature = "http2")]
86-
H2(#[pin] proto::h2::ClientTask<B>, PhantomData<fn(T)>),
78+
pin_project! {
79+
#[project = ProtoClientProj]
80+
enum ProtoClient<T, B>
81+
where
82+
B: HttpBody,
83+
{
84+
#[cfg(feature = "http1")]
85+
H1 {
86+
#[pin]
87+
h1: Http1Dispatcher<T, B, proto::h1::ClientTransaction>,
88+
},
89+
#[cfg(feature = "http2")]
90+
H2 {
91+
#[pin]
92+
h2: proto::h2::ClientTask<B>, _phantom: PhantomData<fn(T)>,
93+
},
94+
}
8795
}
8896

8997
/// Returns a handshake future over some IO.
@@ -400,7 +408,7 @@ where
400408
pub fn into_parts(self) -> Parts<T> {
401409
match self.inner.expect("already upgraded") {
402410
#[cfg(feature = "http1")]
403-
ProtoClient::H1(h1) => {
411+
ProtoClient::H1 { h1 } => {
404412
let (io, read_buf, _) = h1.into_inner();
405413
Parts {
406414
io,
@@ -409,7 +417,7 @@ where
409417
}
410418
}
411419
#[cfg(feature = "http2")]
412-
ProtoClient::H2(..) => {
420+
ProtoClient::H2 { .. } => {
413421
panic!("http2 cannot into_inner");
414422
}
415423
}
@@ -429,9 +437,9 @@ where
429437
pub fn poll_without_shutdown(&mut self, cx: &mut task::Context<'_>) -> Poll<crate::Result<()>> {
430438
match *self.inner.as_mut().expect("already upgraded") {
431439
#[cfg(feature = "http1")]
432-
ProtoClient::H1(ref mut h1) => h1.poll_without_shutdown(cx),
440+
ProtoClient::H1 { ref mut h1 } => h1.poll_without_shutdown(cx),
433441
#[cfg(feature = "http2")]
434-
ProtoClient::H2(ref mut h2, _) => Pin::new(h2).poll(cx).map_ok(|_| ()),
442+
ProtoClient::H2 { ref mut h2, .. } => Pin::new(h2).poll(cx).map_ok(|_| ()),
435443
}
436444
}
437445

@@ -460,7 +468,7 @@ where
460468
proto::Dispatched::Shutdown => Poll::Ready(Ok(())),
461469
#[cfg(feature = "http1")]
462470
proto::Dispatched::Upgrade(pending) => match self.inner.take() {
463-
Some(ProtoClient::H1(h1)) => {
471+
Some(ProtoClient::H1 { h1 }) => {
464472
let (io, buf, _) = h1.into_inner();
465473
pending.fulfill(Upgraded::new(io, buf));
466474
Poll::Ready(Ok(()))
@@ -707,14 +715,17 @@ impl Builder {
707715
}
708716
let cd = proto::h1::dispatch::Client::new(rx);
709717
let dispatch = proto::h1::Dispatcher::new(cd, conn);
710-
ProtoClient::H1(dispatch)
718+
ProtoClient::H1 { h1: dispatch }
711719
}
712720
#[cfg(feature = "http2")]
713721
Proto::Http2 => {
714722
let h2 =
715723
proto::h2::client::handshake(io, rx, &opts.h2_builder, opts.exec.clone())
716724
.await?;
717-
ProtoClient::H2(h2, PhantomData)
725+
ProtoClient::H2 {
726+
h2,
727+
_phantom: PhantomData,
728+
}
718729
}
719730
};
720731

@@ -768,9 +779,9 @@ where
768779
fn poll(self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Self::Output> {
769780
match self.project() {
770781
#[cfg(feature = "http1")]
771-
ProtoClientProj::H1(c) => c.poll(cx),
782+
ProtoClientProj::H1 { h1 } => h1.poll(cx),
772783
#[cfg(feature = "http2")]
773-
ProtoClientProj::H2(c, _) => c.poll(cx),
784+
ProtoClientProj::H2 { h2, .. } => h2.poll(cx),
774785
}
775786
}
776787
}

src/client/connect/http.rs

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use std::time::Duration;
1111

1212
use futures_util::future::Either;
1313
use http::uri::{Scheme, Uri};
14-
use pin_project::pin_project;
14+
use pin_project_lite::pin_project;
1515
use tokio::net::{TcpSocket, TcpStream};
1616
use tokio::time::Sleep;
1717

@@ -373,18 +373,19 @@ impl HttpInfo {
373373
}
374374
}
375375

376-
// Not publicly exported (so missing_docs doesn't trigger).
377-
//
378-
// We return this `Future` instead of the `Pin<Box<dyn Future>>` directly
379-
// so that users don't rely on it fitting in a `Pin<Box<dyn Future>>` slot
380-
// (and thus we can change the type in the future).
381-
#[must_use = "futures do nothing unless polled"]
382-
#[pin_project]
383-
#[allow(missing_debug_implementations)]
384-
pub struct HttpConnecting<R> {
385-
#[pin]
386-
fut: BoxConnecting,
387-
_marker: PhantomData<R>,
376+
pin_project! {
377+
// Not publicly exported (so missing_docs doesn't trigger).
378+
//
379+
// We return this `Future` instead of the `Pin<Box<dyn Future>>` directly
380+
// so that users don't rely on it fitting in a `Pin<Box<dyn Future>>` slot
381+
// (and thus we can change the type in the future).
382+
#[must_use = "futures do nothing unless polled"]
383+
#[allow(missing_debug_implementations)]
384+
pub struct HttpConnecting<R> {
385+
#[pin]
386+
fut: BoxConnecting,
387+
_marker: PhantomData<R>,
388+
}
388389
}
389390

390391
type ConnectResult = Result<TcpStream, ConnectError>;

src/client/pool.rs

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use futures_channel::oneshot;
1111
use tokio::time::{Duration, Instant, Interval};
1212

1313
use super::client::Ver;
14-
use crate::common::{task, exec::Exec, Future, Pin, Poll, Unpin};
14+
use crate::common::{exec::Exec, task, Future, Pin, Poll, Unpin};
1515

1616
// FIXME: allow() required due to `impl Trait` leaking types to this lint
1717
#[allow(missing_debug_implementations)]
@@ -714,16 +714,17 @@ impl Expiration {
714714
}
715715

716716
#[cfg(feature = "runtime")]
717-
#[pin_project::pin_project]
718-
struct IdleTask<T> {
719-
#[pin]
720-
interval: Interval,
721-
pool: WeakOpt<Mutex<PoolInner<T>>>,
722-
// This allows the IdleTask to be notified as soon as the entire
723-
// Pool is fully dropped, and shutdown. This channel is never sent on,
724-
// but Err(Canceled) will be received when the Pool is dropped.
725-
#[pin]
726-
pool_drop_notifier: oneshot::Receiver<crate::common::Never>,
717+
pin_project_lite::pin_project! {
718+
struct IdleTask<T> {
719+
#[pin]
720+
interval: Interval,
721+
pool: WeakOpt<Mutex<PoolInner<T>>>,
722+
// This allows the IdleTask to be notified as soon as the entire
723+
// Pool is fully dropped, and shutdown. This channel is never sent on,
724+
// but Err(Canceled) will be received when the Pool is dropped.
725+
#[pin]
726+
pool_drop_notifier: oneshot::Receiver<crate::common::Never>,
727+
}
727728
}
728729

729730
#[cfg(feature = "runtime")]
@@ -776,7 +777,7 @@ mod tests {
776777
use std::time::Duration;
777778

778779
use super::{Connecting, Key, Pool, Poolable, Reservation, WeakOpt};
779-
use crate::common::{task, exec::Exec, Future, Pin};
780+
use crate::common::{exec::Exec, task, Future, Pin};
780781

781782
/// Test unique reservations.
782783
#[derive(Debug, PartialEq, Eq)]

src/common/drain.rs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use std::mem;
22

3-
use pin_project::pin_project;
3+
use pin_project_lite::pin_project;
44
use tokio::sync::watch;
55

66
use super::{task, Future, Pin, Poll};
@@ -21,14 +21,15 @@ pub(crate) struct Watch {
2121
rx: watch::Receiver<()>,
2222
}
2323

24-
#[allow(missing_debug_implementations)]
25-
#[pin_project]
26-
pub struct Watching<F, FN> {
27-
#[pin]
28-
future: F,
29-
state: State<FN>,
30-
watch: Pin<Box<dyn Future<Output = ()> + Send + Sync>>,
31-
_rx: watch::Receiver<()>,
24+
pin_project! {
25+
#[allow(missing_debug_implementations)]
26+
pub struct Watching<F, FN> {
27+
#[pin]
28+
future: F,
29+
state: State<FN>,
30+
watch: Pin<Box<dyn Future<Output = ()> + Send + Sync>>,
31+
_rx: watch::Receiver<()>,
32+
}
3233
}
3334

3435
enum State<F> {

src/proto/h1/dispatch.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,13 @@ cfg_server! {
4444
}
4545

4646
cfg_client! {
47-
pub(crate) struct Client<B> {
48-
callback: Option<crate::client::dispatch::Callback<Request<B>, http::Response<Body>>>,
49-
rx: ClientRx<B>,
50-
rx_closed: bool,
47+
pin_project_lite::pin_project! {
48+
pub(crate) struct Client<B> {
49+
callback: Option<crate::client::dispatch::Callback<Request<B>, http::Response<Body>>>,
50+
#[pin]
51+
rx: ClientRx<B>,
52+
rx_closed: bool,
53+
}
5154
}
5255

5356
type ClientRx<B> = crate::client::dispatch::Receiver<Request<B>, http::Response<Body>>;

src/proto/h2/mod.rs

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use http::header::{
55
TRANSFER_ENCODING, UPGRADE,
66
};
77
use http::HeaderMap;
8-
use pin_project::pin_project;
8+
use pin_project_lite::pin_project;
99
use std::error::Error as StdError;
1010
use std::io::IoSlice;
1111

@@ -94,15 +94,16 @@ fn decode_content_length(headers: &HeaderMap) -> DecodedLength {
9494

9595
// body adapters used by both Client and Server
9696

97-
#[pin_project]
98-
struct PipeToSendStream<S>
99-
where
100-
S: HttpBody,
101-
{
102-
body_tx: SendStream<SendBuf<S::Data>>,
103-
data_done: bool,
104-
#[pin]
105-
stream: S,
97+
pin_project! {
98+
struct PipeToSendStream<S>
99+
where
100+
S: HttpBody,
101+
{
102+
body_tx: SendStream<SendBuf<S::Data>>,
103+
data_done: bool,
104+
#[pin]
105+
stream: S,
106+
}
106107
}
107108

108109
impl<S> PipeToSendStream<S>

0 commit comments

Comments
 (0)