mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-27 17:52:56 +01:00
14 lines
4.9 KiB
HTML
14 lines
4.9 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="Perform WebSocket handshake and start actor."><title>start_with_addr in actix_web_actors::ws - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_web_actors" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../actix_web_actors/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../actix_web_actors/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_web_actors/index.html">actix_web_actors</a><span class="version">4.3.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_web_actors::ws</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">actix_web_actors</a>::<wbr><a href="index.html">ws</a>::<wbr><a class="fn" href="#">start_with_addr</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/actix_web_actors/ws.rs.html#323-335">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn start_with_addr<A, T>(
|
|
actor: A,
|
|
req: &HttpRequest,
|
|
stream: T
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(Addr<A>, HttpResponse), Error><div class="where">where
|
|
A: Actor<Context = <a class="struct" href="struct.WebsocketContext.html" title="struct actix_web_actors::ws::WebsocketContext">WebsocketContext</a><A>> + StreamHandler<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="enum.Message.html" title="enum actix_web_actors::ws::Message">Message</a>, <a class="enum" href="enum.ProtocolError.html" title="enum actix_web_actors::ws::ProtocolError">ProtocolError</a>>>,
|
|
T: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, PayloadError>> + 'static,</div></code></pre><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 4.0.0: Prefer <code>WsResponseBuilder::start_with_addr</code>.</span></div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Perform WebSocket handshake and start actor.</p>
|
|
<p><code>req</code> is an HTTP Request that should be requesting a websocket protocol change. <code>stream</code> should
|
|
be a <code>Bytes</code> stream (such as <code>actix_web::web::Payload</code>) that contains a stream of the
|
|
body request.</p>
|
|
<p>If there is a problem with the handshake, an error is returned.</p>
|
|
<p>If successful, returns a pair where the first item is an address for the created actor and the
|
|
second item is the response that should be returned from the WebSocket request.</p>
|
|
</div></details></section></div></main></body></html> |