mirror of
https://github.com/actix/actix-website
synced 2024-11-25 09:12:42 +01:00
28 lines
15 KiB
HTML
28 lines
15 KiB
HTML
|
<!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="API documentation for the Rust `Client` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Client"><title>actix_web::ws::Client - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct Client</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_connector">with_connector</a><a href="#method.protocols">protocols</a><a href="#method.cookie">cookie</a><a href="#method.origin">origin</a><a href="#method.max_frame_size">max_frame_size</a><a href="#method.write_buffer_capacity">write_buffer_capacity</a><a href="#method.no_masking">no_masking</a><a href="#method.header">header</a><a href="#method.timeout">timeout</a><a href="#method.connect">connect</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'Client', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>Client</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/ws/client.rs.html#122-131' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Client { /* fields omitted */ }</pre></div><div class='docblock'><p><code>WebSocket</code> client</p>
|
|||
|
|
<p>Example of <code>WebSocket</code> client usage is available in
|
|||
|
|
<a href="https://github.com/actix/examples/blob/master/websocket/src/client.rs#L24">websocket example</a></p>
|
|||
|
|
</div>
|
|||
|
|
<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/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</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/ws/client.rs.html#133-274' 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><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>>>(uri: S) -> <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#135-137' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new websocket connection</p>
|
|||
|
|
</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.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.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>
|
|||
|
|
</div><h4 id='method.connect' class="method"><span id='connect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connect' class='fnname'>connect</a>(&mut self) -> <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</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#229-273' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connect to websocket server and do ws handshake</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='synthetic-implementations' class='small-section-header'>
|
|||
|
|
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='synthetic-implementations-list'>
|
|||
|
|
<h3 id='impl-Send' 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/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' 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/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|