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
@ -9,13 +9,13 @@
|
||||
</div><h4 id='method.with_connector' class="method"><span id='with_connector.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_connector' class='fnname'>with_connector</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>(<br> uri: S, <br> conn: <a class="struct" href="../../actix_web/actix/actix/struct.Addr.html" title="struct actix_web::actix::actix::Addr">Addr</a><<a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a>><br>) -> <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#140-153' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new websocket connection with custom <code>ClientConnector</code></p>
|
||||
</div><h4 id='method.protocols' class="method"><span id='protocols.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.protocols' class='fnname'>protocols</a><U, V>(self, protos: U) -> Self <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = V> + 'static,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#156-167' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set supported websocket protocols</p>
|
||||
</div><h4 id='method.cookie' class="method"><span id='cookie.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.cookie' class='fnname'>cookie</a>(self, cookie: <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#170-173' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set cookie for handshake request</p>
|
||||
</div><h4 id='method.origin' class="method"><span id='origin.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.origin' class='fnname'>origin</a><V>(self, origin: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>: <a class="trait" href="https://docs.rs/http/0.1.7/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><V>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#176-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request Origin</p>
|
||||
</div><h4 id='method.origin' class="method"><span id='origin.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.origin' class='fnname'>origin</a><V>(self, origin: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>: <a class="trait" href="https://docs.rs/http/0.1.8/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><V>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#176-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request Origin</p>
|
||||
</div><h4 id='method.max_frame_size' class="method"><span id='max_frame_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.max_frame_size' class='fnname'>max_frame_size</a>(self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#190-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set max frame size</p>
|
||||
<p>By default max size is set to 64kb</p>
|
||||
</div><h4 id='method.write_buffer_capacity' class="method"><span id='write_buffer_capacity.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write_buffer_capacity' class='fnname'>write_buffer_capacity</a>(self, cap: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#198-201' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set write buffer capacity</p>
|
||||
<p>Default buffer capacity is 32kb</p>
|
||||
</div><h4 id='method.no_masking' class="method"><span id='no_masking.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.no_masking' class='fnname'>no_masking</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#204-207' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disable payload masking. By default ws client masks frame payload.</p>
|
||||
</div><h4 id='method.header' class="method"><span id='header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.header' class='fnname'>header</a><K, V>(self, key: K, value: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderName.html" title="struct actix_web::http::header::HeaderName">HeaderName</a>: <a class="trait" href="https://docs.rs/http/0.1.7/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><K>,<br> V: IntoHeaderValue, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#210-217' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request header</p>
|
||||
</div><h4 id='method.header' class="method"><span id='header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.header' class='fnname'>header</a><K, V>(self, key: K, value: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderName.html" title="struct actix_web::http::header::HeaderName">HeaderName</a>: <a class="trait" href="https://docs.rs/http/0.1.8/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><K>,<br> V: IntoHeaderValue, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#210-217' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request header</p>
|
||||
</div><h4 id='method.timeout' class="method"><span id='timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.timeout' class='fnname'>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>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#223-226' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set websocket handshake timeout</p>
|
||||
<p>Handshake timeout is a total time for successful handshake.
|
||||
Default value is 5 seconds.</p>
|
||||
|
||||
Reference in New Issue
Block a user