| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/hyper-timeout-0.4.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../hyper_timeout/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../hyper_timeout/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::future::Future; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>std::time::Duration; |
| |
| <span class="kw">use </span>tokio::io::{AsyncRead, AsyncWrite}; |
| <span class="kw">use </span>tokio::time::timeout; |
| <span class="kw">use </span>tokio_io_timeout::TimeoutStream; |
| |
| <span class="kw">use </span>hyper::client::connect::{Connected, Connection}; |
| <span class="kw">use </span>hyper::{service::Service, Uri}; |
| |
| <span class="kw">mod </span>stream; |
| |
| <span class="kw">use </span>stream::TimeoutConnectorStream; |
| |
| <span class="kw">type </span>BoxError = Box<<span class="kw">dyn </span>std::error::Error + Send + Sync>; |
| |
| <span class="doccomment">/// A connector that enforces as connection timeout |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>TimeoutConnector<T> { |
| <span class="doccomment">/// A connector implementing the `Connect` trait |
| </span>connector: T, |
| <span class="doccomment">/// Amount of time to wait connecting |
| </span>connect_timeout: <span class="prelude-ty">Option</span><Duration>, |
| <span class="doccomment">/// Amount of time to wait reading response |
| </span>read_timeout: <span class="prelude-ty">Option</span><Duration>, |
| <span class="doccomment">/// Amount of time to wait writing request |
| </span>write_timeout: <span class="prelude-ty">Option</span><Duration>, |
| } |
| |
| <span class="kw">impl</span><T> TimeoutConnector<T> |
| <span class="kw">where |
| </span>T: Service<Uri> + Send, |
| T::Response: AsyncRead + AsyncWrite + Send + Unpin, |
| T::Future: Send + <span class="lifetime">'static</span>, |
| T::Error: Into<BoxError>, |
| { |
| <span class="doccomment">/// Construct a new TimeoutConnector with a given connector implementing the `Connect` trait |
| </span><span class="kw">pub fn </span>new(connector: T) -> <span class="self">Self </span>{ |
| TimeoutConnector { |
| connector, |
| connect_timeout: <span class="prelude-val">None</span>, |
| read_timeout: <span class="prelude-val">None</span>, |
| write_timeout: <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Service<Uri> <span class="kw">for </span>TimeoutConnector<T> |
| <span class="kw">where |
| </span>T: Service<Uri> + Send, |
| T::Response: AsyncRead + AsyncWrite + Connection + Send + Unpin, |
| T::Future: Send + <span class="lifetime">'static</span>, |
| T::Error: Into<BoxError>, |
| { |
| <span class="kw">type </span>Response = Pin<Box<TimeoutConnectorStream<T::Response>>>; |
| <span class="kw">type </span>Error = BoxError; |
| <span class="attribute">#[allow(clippy::type_complexity)] |
| </span><span class="kw">type </span>Future = Pin<Box<<span class="kw">dyn </span>Future<Output = <span class="prelude-ty">Result</span><<span class="self">Self</span>::Response, <span class="self">Self</span>::Error>> + Send>>; |
| |
| <span class="kw">fn </span>poll_ready(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { |
| <span class="self">self</span>.connector.poll_ready(cx).map_err(Into::into) |
| } |
| |
| <span class="kw">fn </span>call(<span class="kw-2">&mut </span><span class="self">self</span>, dst: Uri) -> <span class="self">Self</span>::Future { |
| <span class="kw">let </span>connect_timeout = <span class="self">self</span>.connect_timeout; |
| <span class="kw">let </span>read_timeout = <span class="self">self</span>.read_timeout; |
| <span class="kw">let </span>write_timeout = <span class="self">self</span>.write_timeout; |
| <span class="kw">let </span>connecting = <span class="self">self</span>.connector.call(dst); |
| |
| <span class="kw">let </span>fut = <span class="kw">async move </span>{ |
| <span class="kw">let </span>stream = <span class="kw">match </span>connect_timeout { |
| <span class="prelude-val">None </span>=> { |
| <span class="kw">let </span>io = connecting.<span class="kw">await</span>.map_err(Into::into)<span class="question-mark">?</span>; |
| TimeoutStream::new(io) |
| } |
| <span class="prelude-val">Some</span>(connect_timeout) => { |
| <span class="kw">let </span>timeout = timeout(connect_timeout, connecting); |
| <span class="kw">let </span>connecting = timeout |
| .<span class="kw">await |
| </span>.map_err(|e| io::Error::new(io::ErrorKind::TimedOut, e))<span class="question-mark">?</span>; |
| <span class="kw">let </span>io = connecting.map_err(Into::into)<span class="question-mark">?</span>; |
| TimeoutStream::new(io) |
| } |
| }; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>tm = TimeoutConnectorStream::new(stream); |
| tm.set_read_timeout(read_timeout); |
| tm.set_write_timeout(write_timeout); |
| <span class="prelude-val">Ok</span>(Box::pin(tm)) |
| }; |
| |
| Box::pin(fut) |
| } |
| } |
| |
| <span class="kw">impl</span><T> TimeoutConnector<T> { |
| <span class="doccomment">/// Set the timeout for connecting to a URL. |
| /// |
| /// Default is no timeout. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_connect_timeout(<span class="kw-2">&mut </span><span class="self">self</span>, val: <span class="prelude-ty">Option</span><Duration>) { |
| <span class="self">self</span>.connect_timeout = val; |
| } |
| |
| <span class="doccomment">/// Set the timeout for the response. |
| /// |
| /// Default is no timeout. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_read_timeout(<span class="kw-2">&mut </span><span class="self">self</span>, val: <span class="prelude-ty">Option</span><Duration>) { |
| <span class="self">self</span>.read_timeout = val; |
| } |
| |
| <span class="doccomment">/// Set the timeout for the request. |
| /// |
| /// Default is no timeout. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_write_timeout(<span class="kw-2">&mut </span><span class="self">self</span>, val: <span class="prelude-ty">Option</span><Duration>) { |
| <span class="self">self</span>.write_timeout = val; |
| } |
| } |
| |
| <span class="kw">impl</span><T> Connection <span class="kw">for </span>TimeoutConnector<T> |
| <span class="kw">where |
| </span>T: AsyncRead + AsyncWrite + Connection + Service<Uri> + Send + Unpin, |
| T::Response: AsyncRead + AsyncWrite + Send + Unpin, |
| T::Future: Send + <span class="lifetime">'static</span>, |
| T::Error: Into<BoxError>, |
| { |
| <span class="kw">fn </span>connected(<span class="kw-2">&</span><span class="self">self</span>) -> Connected { |
| <span class="self">self</span>.connector.connected() |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::error::Error; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::time::Duration; |
| |
| <span class="kw">use </span>hyper::client::HttpConnector; |
| <span class="kw">use </span>hyper::Client; |
| |
| <span class="kw">use </span><span class="kw">super</span>::TimeoutConnector; |
| |
| <span class="attribute">#[tokio::test] |
| </span><span class="kw">async fn </span>test_timeout_connector() { |
| <span class="comment">// 10.255.255.1 is a not a routable IP address |
| </span><span class="kw">let </span>url = <span class="string">"http://10.255.255.1"</span>.parse().unwrap(); |
| |
| <span class="kw">let </span>http = HttpConnector::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>connector = TimeoutConnector::new(http); |
| connector.set_connect_timeout(<span class="prelude-val">Some</span>(Duration::from_millis(<span class="number">1</span>))); |
| |
| <span class="kw">let </span>client = Client::builder().build::<<span class="kw">_</span>, hyper::Body>(connector); |
| |
| <span class="kw">let </span>res = client.get(url).<span class="kw">await</span>; |
| |
| <span class="kw">match </span>res { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(<span class="string">"Expected a timeout"</span>), |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(io_e) = e.source().unwrap().downcast_ref::<io::Error>() { |
| <span class="macro">assert_eq!</span>(io_e.kind(), io::ErrorKind::TimedOut); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"Expected timeout error"</span>); |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[tokio::test] |
| </span><span class="kw">async fn </span>test_read_timeout() { |
| <span class="kw">let </span>url = <span class="string">"http://example.com"</span>.parse().unwrap(); |
| |
| <span class="kw">let </span>http = HttpConnector::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>connector = TimeoutConnector::new(http); |
| <span class="comment">// A 1 ms read timeout should be so short that we trigger a timeout error |
| </span>connector.set_read_timeout(<span class="prelude-val">Some</span>(Duration::from_millis(<span class="number">1</span>))); |
| |
| <span class="kw">let </span>client = Client::builder().build::<<span class="kw">_</span>, hyper::Body>(connector); |
| |
| <span class="kw">let </span>res = client.get(url).<span class="kw">await</span>; |
| |
| <span class="kw">match </span>res { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(<span class="string">"Expected a timeout"</span>), |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(io_e) = e.source().unwrap().downcast_ref::<io::Error>() { |
| <span class="macro">assert_eq!</span>(io_e.kind(), io::ErrorKind::TimedOut); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"Expected timeout error"</span>); |
| } |
| } |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper_timeout" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
