Skip to content

Commit

Permalink
Merge pull request #22 from hatoo/doc
Browse files Browse the repository at this point in the history
add few docs
  • Loading branch information
hatoo authored Jun 22, 2024
2 parents 1a92c95 + c32969c commit 58fd563
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ pub struct Upgrade {
pub struct Communication<B> {
/// Client address
pub client_addr: std::net::SocketAddr,
/// Request from client. request.uri() is an absolute URI.
/// Request from client. request.uri() is an absolute URI except for `CONNECT` method.
/// If you modify uri of `CONNECT` method, subsequent request will be sent to the modified uri (off course you can modify it). But `HOST` header remains the original value.
pub request: Request<Incoming>,
/// Send request back to server. You can modify request before sending it back.
/// NOTE: If you drop this without send(), communication will be canceled and server will not receive request and client will get 500 Internal Server Error.
Expand Down

0 comments on commit 58fd563

Please sign in to comment.