Skip to content

Commit 9420b73

Browse files
authored
docs(client,server): added note about stability of Builder struct default options (#3366)
Closes #3336
1 parent dd638b5 commit 9420b73

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

src/client/conn/http1.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ where
9797
/// A builder to configure an HTTP connection.
9898
///
9999
/// After setting options, the builder is used to create a handshake future.
100+
///
101+
/// **Note**: The default values of options are *not considered stable*. They
102+
/// are subject to change at any time.
100103
#[derive(Clone, Debug)]
101104
pub struct Builder {
102105
h09_responses: bool,

src/client/conn/http2.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ where
5050
/// A builder to configure an HTTP connection.
5151
///
5252
/// After setting options, the builder is used to create a handshake future.
53+
///
54+
/// **Note**: The default values of options are *not considered stable*. They
55+
/// are subject to change at any time.
5356
#[derive(Clone, Debug)]
5457
pub struct Builder<Ex> {
5558
pub(super) exec: Ex,

src/server/conn/http1.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ pin_project_lite::pin_project! {
4141
}
4242

4343
/// A configuration builder for HTTP/1 server connections.
44+
///
45+
/// **Note**: The default values of options are *not considered stable*. They
46+
/// are subject to change at any time.
4447
#[derive(Clone, Debug)]
4548
pub struct Builder {
4649
timer: Time,

src/server/conn/http2.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ pin_project! {
3535
}
3636

3737
/// A configuration builder for HTTP/2 server connections.
38+
///
39+
/// **Note**: The default values of options are *not considered stable*. They
40+
/// are subject to change at any time.
3841
#[derive(Clone, Debug)]
3942
pub struct Builder<E> {
4043
exec: E,

0 commit comments

Comments
 (0)