Skip to content

Commit

Permalink
docs(client,server): added note about stability of Builder struct def…
Browse files Browse the repository at this point in the history
…ault options (hyperium#3366)

Closes hyperium#3336
  • Loading branch information
newmanifold authored and 0xE282B0 committed Jan 12, 2024
1 parent 106c500 commit 4c425fb
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/client/conn/http1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions src/client/conn/http2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<Ex> {
pub(super) exec: Ex,
Expand Down
3 changes: 3 additions & 0 deletions src/server/conn/http1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions src/server/conn/http2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<E> {
exec: E,
Expand Down

0 comments on commit 4c425fb

Please sign in to comment.