From 42eb4aa69a9bac44dfed7d2962d9843f756968ad Mon Sep 17 00:00:00 2001 From: Gaurav Dhiman Date: Fri, 20 Oct 2023 23:45:57 +0200 Subject: [PATCH 1/3] docs(client,server): added note about stability of Builder struct defaults --- src/client/conn/http1.rs | 3 +++ src/client/conn/http2.rs | 3 +++ src/server/conn/http1.rs | 3 +++ src/server/conn/http2.rs | 3 +++ 4 files changed, 12 insertions(+) diff --git a/src/client/conn/http1.rs b/src/client/conn/http1.rs index c487b1927a..8eaaa5ee64 100644 --- a/src/client/conn/http1.rs +++ b/src/client/conn/http1.rs @@ -97,6 +97,9 @@ where /// A builder to configure an HTTP connection. /// /// After setting options, the builder is used to create a handshake future. +/// +/// **Note**: The default values of options are *not considered stable*. They +/// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { h09_responses: bool, diff --git a/src/client/conn/http2.rs b/src/client/conn/http2.rs index ec8ecf3e08..5b7d02b751 100644 --- a/src/client/conn/http2.rs +++ b/src/client/conn/http2.rs @@ -50,6 +50,9 @@ where /// A builder to configure an HTTP connection. /// /// After setting options, the builder is used to create a handshake future. +/// +/// **Note**: The default values of options are *not considered stable*. They +/// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { pub(super) exec: Ex, diff --git a/src/server/conn/http1.rs b/src/server/conn/http1.rs index d4b8924e9f..ccce8d7a50 100644 --- a/src/server/conn/http1.rs +++ b/src/server/conn/http1.rs @@ -41,6 +41,9 @@ pin_project_lite::pin_project! { } /// A configuration builder for HTTP/1 server connections. +/// +/// **Note**: The default values of options are *not considered stable*. They +/// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { timer: Time, diff --git a/src/server/conn/http2.rs b/src/server/conn/http2.rs index 1af3d4a36e..4ef4b7f0f2 100644 --- a/src/server/conn/http2.rs +++ b/src/server/conn/http2.rs @@ -35,6 +35,9 @@ pin_project! { } /// A configuration builder for HTTP/2 server connections. +/// +/// **Note**: The default values of options are *not considered stable*. They +/// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { exec: E, From ba7fa83ff31610c4bee06bfd4a556d9f3d45300a Mon Sep 17 00:00:00 2001 From: Gaurav Dhiman Date: Sat, 21 Oct 2023 02:52:17 +0200 Subject: [PATCH 2/3] fix style check --- src/client/conn/http1.rs | 4 ++-- src/client/conn/http2.rs | 4 ++-- src/server/conn/http1.rs | 4 ++-- src/server/conn/http2.rs | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/client/conn/http1.rs b/src/client/conn/http1.rs index 8eaaa5ee64..63ba841fbd 100644 --- a/src/client/conn/http1.rs +++ b/src/client/conn/http1.rs @@ -97,8 +97,8 @@ where /// A builder to configure an HTTP connection. /// /// After setting options, the builder is used to create a handshake future. -/// -/// **Note**: The default values of options are *not considered stable*. They +/// +/// **Note**: The default values of options are *not considered stable*. They /// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { diff --git a/src/client/conn/http2.rs b/src/client/conn/http2.rs index 5b7d02b751..e1a218dcd5 100644 --- a/src/client/conn/http2.rs +++ b/src/client/conn/http2.rs @@ -50,8 +50,8 @@ where /// A builder to configure an HTTP connection. /// /// After setting options, the builder is used to create a handshake future. -/// -/// **Note**: The default values of options are *not considered stable*. They +/// +/// **Note**: The default values of options are *not considered stable*. They /// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { diff --git a/src/server/conn/http1.rs b/src/server/conn/http1.rs index ccce8d7a50..4d35de92d1 100644 --- a/src/server/conn/http1.rs +++ b/src/server/conn/http1.rs @@ -41,8 +41,8 @@ pin_project_lite::pin_project! { } /// A configuration builder for HTTP/1 server connections. -/// -/// **Note**: The default values of options are *not considered stable*. They +/// +/// **Note**: The default values of options are *not considered stable*. They /// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { diff --git a/src/server/conn/http2.rs b/src/server/conn/http2.rs index 4ef4b7f0f2..e872f3ca39 100644 --- a/src/server/conn/http2.rs +++ b/src/server/conn/http2.rs @@ -35,8 +35,8 @@ pin_project! { } /// A configuration builder for HTTP/2 server connections. -/// -/// **Note**: The default values of options are *not considered stable*. They +/// +/// **Note**: The default values of options are *not considered stable*. They /// are subject to change at any time #[derive(Clone, Debug)] pub struct Builder { From cd7b99bd26d6e61b0f3499f1d17639dfab22dc0b Mon Sep 17 00:00:00 2001 From: Gaurav Dhiman Date: Sat, 21 Oct 2023 18:59:20 +0200 Subject: [PATCH 3/3] docs(client,server): added period to the Builder's note --- src/client/conn/http1.rs | 2 +- src/client/conn/http2.rs | 2 +- src/server/conn/http1.rs | 2 +- src/server/conn/http2.rs | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/client/conn/http1.rs b/src/client/conn/http1.rs index 63ba841fbd..60db767a42 100644 --- a/src/client/conn/http1.rs +++ b/src/client/conn/http1.rs @@ -99,7 +99,7 @@ where /// After setting options, the builder is used to create a handshake future. /// /// **Note**: The default values of options are *not considered stable*. They -/// are subject to change at any time +/// are subject to change at any time. #[derive(Clone, Debug)] pub struct Builder { h09_responses: bool, diff --git a/src/client/conn/http2.rs b/src/client/conn/http2.rs index e1a218dcd5..f4cdcd5e9f 100644 --- a/src/client/conn/http2.rs +++ b/src/client/conn/http2.rs @@ -52,7 +52,7 @@ where /// After setting options, the builder is used to create a handshake future. /// /// **Note**: The default values of options are *not considered stable*. They -/// are subject to change at any time +/// are subject to change at any time. #[derive(Clone, Debug)] pub struct Builder { pub(super) exec: Ex, diff --git a/src/server/conn/http1.rs b/src/server/conn/http1.rs index 4d35de92d1..c498636ff9 100644 --- a/src/server/conn/http1.rs +++ b/src/server/conn/http1.rs @@ -43,7 +43,7 @@ pin_project_lite::pin_project! { /// A configuration builder for HTTP/1 server connections. /// /// **Note**: The default values of options are *not considered stable*. They -/// are subject to change at any time +/// are subject to change at any time. #[derive(Clone, Debug)] pub struct Builder { timer: Time, diff --git a/src/server/conn/http2.rs b/src/server/conn/http2.rs index e872f3ca39..d35f2df354 100644 --- a/src/server/conn/http2.rs +++ b/src/server/conn/http2.rs @@ -37,7 +37,7 @@ pin_project! { /// A configuration builder for HTTP/2 server connections. /// /// **Note**: The default values of options are *not considered stable*. They -/// are subject to change at any time +/// are subject to change at any time. #[derive(Clone, Debug)] pub struct Builder { exec: E,