1
0
mirror of https://github.com/actix/actix-website synced 2025-06-30 16:54:27 +02:00

update stable docs

This commit is contained in:
Nikolay Kim
2018-07-26 10:53:41 -07:00
parent 0c2153597f
commit 90165ac1cc
2025 changed files with 116162 additions and 2957 deletions

View File

@ -4,7 +4,7 @@
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#60-87' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>&lt;U&gt;(uri: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>, <a class="struct" href="https://docs.rs/http/0.1.7/http/error/struct.Error.html" title="struct http::error::Error">HttpError</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://docs.rs/http/0.1.7/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://docs.rs/http/0.1.7/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a>&lt;U&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#62-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create <code>Connect</code> message for specified <code>Uri</code></p>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#60-87' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>&lt;U&gt;(uri: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>, <a class="struct" href="https://docs.rs/http/0.1.8/http/error/struct.Error.html" title="struct http::error::Error">HttpError</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://docs.rs/http/0.1.8/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://docs.rs/http/0.1.8/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a>&lt;U&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#62-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create <code>Connect</code> message for specified <code>Uri</code></p>
</div><h4 id='method.conn_timeout' class="method"><span id='conn_timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.conn_timeout' class='fnname'>conn_timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#75-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connection timeout, i.e. max time to connect to remote host.
Set to 1 second by default.</p>
</div><h4 id='method.wait_timeout' class="method"><span id='wait_timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.wait_timeout' class='fnname'>wait_timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#83-86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>If connection pool limits are enabled, wait time indicates
@ -15,11 +15,11 @@ Set to 5 seconds by default.</p>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#51' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#51' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Message' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> for <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a></code><a href='#impl-Message' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#89-91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result' class="type"><span id='Result.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result' class="type">Result</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connection.html" title="struct actix_web::client::Connection">Connection</a>, <a class="enum" href="../../actix_web/client/enum.ClientConnectorError.html" title="enum actix_web::client::ClientConnectorError">ClientConnectorError</a>&gt;</code></span></h4>
<div class='docblock'><p>The type of value that this message will resolved with if it is successful. <a href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result">Read more</a></p>
</div></div><h3 id='impl-Handler%3CConnect%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/actix/actix/dev/trait.Handler.html" title="trait actix_web::actix::actix::dev::Handler">Handler</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>&gt; for <a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a></code><a href='#impl-Handler%3CConnect%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#761-906' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result-1' class="type"><span id='Result.t-1' class='invisible'><code>type <a href='../../actix_web/actix/actix/dev/trait.Handler.html#associatedtype.Result' class="type">Result</a> = <a class="struct" href="../../actix_web/actix/actix/dev/struct.ActorResponse.html" title="struct actix_web::actix::actix::dev::ActorResponse">ActorResponse</a>&lt;<a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a>, <a class="struct" href="../../actix_web/client/struct.Connection.html" title="struct actix_web::client::Connection">Connection</a>, <a class="enum" href="../../actix_web/client/enum.ClientConnectorError.html" title="enum actix_web::client::ClientConnectorError">ClientConnectorError</a>&gt;</code></span></h4>
</div></div><h3 id='impl-Message' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/actix/actix/trait.Message.html" title="trait actix_web::actix::actix::Message">Message</a> for <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a></code><a href='#impl-Message' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#89-91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result' class="type"><span id='Result.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/trait.Message.html#associatedtype.Result' class="type">Result</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connection.html" title="struct actix_web::client::Connection">Connection</a>, <a class="enum" href="../../actix_web/client/enum.ClientConnectorError.html" title="enum actix_web::client::ClientConnectorError">ClientConnectorError</a>&gt;</code></span></h4>
<div class='docblock'><p>The type of value that this message will resolved with if it is successful. <a href="../../actix_web/actix/actix/trait.Message.html#associatedtype.Result">Read more</a></p>
</div></div><h3 id='impl-Handler%3CConnect%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/actix/actix/trait.Handler.html" title="trait actix_web::actix::actix::Handler">Handler</a>&lt;<a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>&gt; for <a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a></code><a href='#impl-Handler%3CConnect%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#762-907' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result-1' class="type"><span id='Result.t-1' class='invisible'><code>type <a href='../../actix_web/actix/actix/trait.Handler.html#associatedtype.Result' class="type">Result</a> = <a class="struct" href="../../actix_web/actix/actix/struct.ActorResponse.html" title="struct actix_web::actix::actix::ActorResponse">ActorResponse</a>&lt;<a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a>, <a class="struct" href="../../actix_web/client/struct.Connection.html" title="struct actix_web::client::Connection">Connection</a>, <a class="enum" href="../../actix_web/client/enum.ClientConnectorError.html" title="enum actix_web::client::ClientConnectorError">ClientConnectorError</a>&gt;</code></span></h4>
<div class='docblock'><p>The type of value that this handle will return</p>
</div><h4 id='method.handle' class="method"><span id='handle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.Handler.html#tymethod.handle' class='fnname'>handle</a>(&amp;mut self, msg: <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>, ctx: &amp;mut Self::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -&gt; Self::<a class="type" href="../../actix_web/actix/actix/dev/trait.Handler.html#associatedtype.Result" title="type actix_web::actix::actix::dev::Handler::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#764-905' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Method is called for every message received by this Actor</p>
</div><h4 id='method.handle' class="method"><span id='handle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.Handler.html#tymethod.handle' class='fnname'>handle</a>(&amp;mut self, msg: <a class="struct" href="../../actix_web/client/struct.Connect.html" title="struct actix_web::client::Connect">Connect</a>, ctx: &amp;mut Self::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -&gt; Self::<a class="type" href="../../actix_web/actix/actix/trait.Handler.html#associatedtype.Result" title="type actix_web::actix::actix::Handler::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/client/connector.rs.html#765-906' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Method is called for every message received by this Actor</p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>