Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(common): move compat constructor to method #3367

Merged
merged 1 commit into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/common/io/compat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ use std::task::{Context, Poll};
#[derive(Debug)]
pub(crate) struct Compat<T>(pub(crate) T);

pub(crate) fn compat<T>(io: T) -> Compat<T> {
Compat(io)
}

impl<T> Compat<T> {
pub(crate) fn new(io: T) -> Self {
Compat(io)
}

fn p(self: Pin<&mut Self>) -> Pin<&mut T> {
// SAFETY: The simplest of projections. This is just
// a wrapper, we don't do anything that would undo the projection.
Expand Down
2 changes: 1 addition & 1 deletion src/common/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ mod compat;
mod rewind;

#[cfg(all(any(feature = "client", feature = "server"), feature = "http2"))]
pub(crate) use self::compat::{compat, Compat};
pub(crate) use self::compat::Compat;
pub(crate) use self::rewind::Rewind;
6 changes: 3 additions & 3 deletions src/common/io/rewind.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ where

#[cfg(test)]
mod tests {
use super::super::compat;
use super::super::Compat;
use super::Rewind;
use bytes::Bytes;
use tokio::io::AsyncReadExt;
Expand All @@ -120,7 +120,7 @@ mod tests {

let mock = tokio_test::io::Builder::new().read(&underlying).build();

let mut stream = compat(Rewind::new(compat(mock)));
let mut stream = Compat::new(Rewind::new(Compat::new(mock)));

// Read off some bytes, ensure we filled o1
let mut buf = [0; 2];
Expand All @@ -143,7 +143,7 @@ mod tests {

let mock = tokio_test::io::Builder::new().read(&underlying).build();

let mut stream = compat(Rewind::new(compat(mock)));
let mut stream = Compat::new(Rewind::new(Compat::new(mock)));

let mut buf = [0; 5];
stream.read_exact(&mut buf).await.expect("read1");
Expand Down
2 changes: 1 addition & 1 deletion src/proto/h1/decode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ mod tests {
async fn read_async(mut decoder: Decoder, content: &[u8], block_at: usize) -> String {
let mut outs = Vec::new();

let mut ins = crate::common::io::compat(if block_at == 0 {
let mut ins = crate::common::io::Compat::new(if block_at == 0 {
tokio_test::io::Builder::new()
.wait(Duration::from_millis(10))
.read(content)
Expand Down
8 changes: 4 additions & 4 deletions src/proto/h1/dispatch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ cfg_client! {
#[cfg(test)]
mod tests {
use super::*;
use crate::common::io::compat;
use crate::common::io::Compat;
use crate::proto::h1::ClientTransaction;
use std::time::Duration;

Expand All @@ -682,7 +682,7 @@ mod tests {
// Block at 0 for now, but we will release this response before
// the request is ready to write later...
let (mut tx, rx) = crate::client::dispatch::channel();
let conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(compat(io));
let conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(Compat::new(io));
let mut dispatcher = Dispatcher::new(Client::new(rx), conn);

// First poll is needed to allow tx to send...
Expand Down Expand Up @@ -719,7 +719,7 @@ mod tests {
.build_with_handle();

let (mut tx, rx) = crate::client::dispatch::channel();
let mut conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(compat(io));
let mut conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(Compat::new(io));
conn.set_write_strategy_queue();

let dispatcher = Dispatcher::new(Client::new(rx), conn);
Expand Down Expand Up @@ -750,7 +750,7 @@ mod tests {
.build();

let (mut tx, rx) = crate::client::dispatch::channel();
let conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(compat(io));
let conn = Conn::<_, bytes::Bytes, ClientTransaction>::new(Compat::new(io));
let mut dispatcher = tokio_test::task::spawn(Dispatcher::new(Client::new(rx), conn));

// First poll is needed to allow tx to send...
Expand Down
10 changes: 5 additions & 5 deletions src/proto/h1/io.rs
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ enum WriteStrategy {

#[cfg(test)]
mod tests {
use crate::common::io::compat;
use crate::common::io::Compat;
use crate::common::time::Time;

use super::*;
Expand Down Expand Up @@ -715,7 +715,7 @@ mod tests {
.wait(Duration::from_secs(1))
.build();

let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(compat(mock));
let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(Compat::new(mock));

// We expect a `parse` to be not ready, and so can't await it directly.
// Rather, this `poll_fn` will wrap the `Poll` result.
Expand Down Expand Up @@ -860,7 +860,7 @@ mod tests {
#[cfg(debug_assertions)] // needs to trigger a debug_assert
fn write_buf_requires_non_empty_bufs() {
let mock = Mock::new().build();
let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(compat(mock));
let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(Compat::new(mock));

buffered.buffer(Cursor::new(Vec::new()));
}
Expand Down Expand Up @@ -895,7 +895,7 @@ mod tests {

let mock = Mock::new().write(b"hello world, it's hyper!").build();

let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(compat(mock));
let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(Compat::new(mock));
buffered.write_buf.set_strategy(WriteStrategy::Flatten);

buffered.headers_buf().extend(b"hello ");
Expand Down Expand Up @@ -954,7 +954,7 @@ mod tests {
.write(b"hyper!")
.build();

let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(compat(mock));
let mut buffered = Buffered::<_, Cursor<Vec<u8>>>::new(Compat::new(mock));
buffered.write_buf.set_strategy(WriteStrategy::Queue);

// we have 4 buffers, and vec IO disabled, but explicitly said
Expand Down
2 changes: 1 addition & 1 deletion src/proto/h2/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ where
B::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
{
let (h2_tx, mut conn) = new_builder(config)
.handshake::<_, SendBuf<B::Data>>(crate::common::io::compat(io))
.handshake::<_, SendBuf<B::Data>>(Compat::new(io))
.await
.map_err(crate::Error::new_h2)?;

Expand Down
7 changes: 4 additions & 3 deletions src/proto/h2/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use pin_project_lite::pin_project;
use super::{ping, PipeToSendStream, SendBuf};
use crate::body::{Body, Incoming as IncomingBody};
use crate::common::date;
use crate::common::io::Compat;
use crate::common::time::Time;
use crate::ext::Protocol;
use crate::headers;
Expand Down Expand Up @@ -90,7 +91,7 @@ where
{
Handshaking {
ping_config: ping::Config,
hs: Handshake<crate::common::io::Compat<T>, SendBuf<B::Data>>,
hs: Handshake<Compat<T>, SendBuf<B::Data>>,
},
Serving(Serving<T, B>),
Closed,
Expand All @@ -101,7 +102,7 @@ where
B: Body,
{
ping: Option<(ping::Recorder, ping::Ponger)>,
conn: Connection<crate::common::io::Compat<T>, SendBuf<B::Data>>,
conn: Connection<Compat<T>, SendBuf<B::Data>>,
closing: Option<crate::Error>,
}

Expand Down Expand Up @@ -133,7 +134,7 @@ where
if config.enable_connect_protocol {
builder.enable_connect_protocol();
}
let handshake = builder.handshake(crate::common::io::compat(io));
let handshake = builder.handshake(Compat::new(io));

let bdp = if config.adaptive_window {
Some(config.initial_stream_window_size)
Expand Down