Skip to content

Commit

Permalink
docs(client): Link from Connection to handshake (#3742)
Browse files Browse the repository at this point in the history
When reading the documentation for `Connection` it is not entirely
obvious how instances of this type are obtained. Add a helpful link,
mostly for those less familiar.
  • Loading branch information
WhyNotHugo authored Aug 23, 2024
1 parent 4c84e8c commit 492ab24
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/client/conn/http1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ pub struct Parts<T> {
///
/// In most cases, this should just be spawned into an executor, so that it
/// can process incoming and outgoing messages, notice hangups, and the like.
///
/// Instances of this type are typically created via the [`handshake`] function
#[must_use = "futures do nothing unless polled"]
pub struct Connection<T, B>
where
Expand Down
2 changes: 2 additions & 0 deletions src/client/conn/http2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ impl<B> Clone for SendRequest<B> {
///
/// In most cases, this should just be spawned into an executor, so that it
/// can process incoming and outgoing messages, notice hangups, and the like.
///
/// Instances of this type are typically created via the [`handshake`] function
#[must_use = "futures do nothing unless polled"]
pub struct Connection<T, B, E>
where
Expand Down

1 comment on commit 492ab24

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'end_to_end'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: 492ab24 Previous: 4c84e8c Ratio
http2_parallel_x10_req_10kb_100_chunks_adaptive_window 25542401 ns/iter (± 17534538.34) 7832543 ns/iter (± 132249.29) 3.26

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.