summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDavid Lönnhager <david.l@mullvad.net>2021-07-13 11:36:55 +0200
committerDavid Lönnhager <david.l@mullvad.net>2021-07-13 15:57:42 +0200
commit6030b3338bd7c53ccf8794dfea26ef5b6dc576ba (patch)
tree4a49f2ef684ec257ecf35135ce6a5796b135af55
parentff4dfa4d2e47d845f95d62f65f391883e7ad54b7 (diff)
downloadmullvadvpn-6030b3338bd7c53ccf8794dfea26ef5b6dc576ba.tar.xz
mullvadvpn-6030b3338bd7c53ccf8794dfea26ef5b6dc576ba.zip
Document TcpStream wrapper
-rw-r--r--mullvad-rpc/src/tcp_stream.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/mullvad-rpc/src/tcp_stream.rs b/mullvad-rpc/src/tcp_stream.rs
index 2919d73b0d..e006c4f3dd 100644
--- a/mullvad-rpc/src/tcp_stream.rs
+++ b/mullvad-rpc/src/tcp_stream.rs
@@ -1,3 +1,6 @@
+//! Wrapper around [`tokio::net::TcpStream`]. This allows in-flight requests to be cancelled
+//! immediately instead of after the socket times out.
+
use futures::channel::oneshot;
use hyper::client::connect::{Connected, Connection};
use std::{