mirror of
https://github.com/actix/actix-website
synced 2024-12-18 09:53:12 +01:00
52 lines
58 KiB
HTML
52 lines
58 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 `WebsocketContext` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, WebsocketContext"><title>actix_web::ws::WebsocketContext - 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 WebsocketContext</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.create">create</a><a href="#method.with_factory">with_factory</a><a href="#method.write_raw">write_raw</a><a href="#method.state">state</a><a href="#method.request">request</a><a href="#method.drain">drain</a><a href="#method.text">text</a><a href="#method.binary">binary</a><a href="#method.ping">ping</a><a href="#method.pong">pong</a><a href="#method.close">close</a><a href="#method.connected">connected</a><a href="#method.handle">handle</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-WsWriter">WsWriter</a><a href="#impl-ActorContext">ActorContext</a><a href="#impl-AsyncContext%3CA%3E">AsyncContext<A></a><a href="#impl-ToEnvelope%3CA%2C%20M%3E">ToEnvelope<A, M></a><a href="#impl-AsyncContextParts%3CA%3E">AsyncContextParts<A></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><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-TryInto">TryInto</a><a href="#impl-Any">Any</a><a href="#impl-Erased">Erased</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: 'WebsocketContext', 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='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/context.rs.html#28-36' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>WebsocketContext</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct WebsocketContext<A, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S>>, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>Execution context for <code>WebSockets</code> actors</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, S: 'static> <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>, </span></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/context.rs.html#89-128' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.create' class="method"><span id='create.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.create' class='fnname'>create</a><P>(req: <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, actor: A, stream: <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><P>) -> <a class="enum" href="../../actix_web/enum.Body.html" title="enum actix_web::Body">Body</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.StreamHandler.html" title="trait actix_web::actix::actix::dev::StreamHandler">StreamHandler</a><<a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a>, <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>>,<br> P: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.10/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#95-110' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new Websocket context from a request and an actor</p>
|
||
</div><h4 id='method.with_factory' class="method"><span id='with_factory.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_factory' class='fnname'>with_factory</a><F>(req: <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, f: F) -> <a class="enum" href="../../actix_web/enum.Body.html" title="enum actix_web::Body">Body</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self) -> A + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#113-127' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new Websocket context</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>, </span></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#130-234' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.write_raw' class="method"><span id='write_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write_raw' class='fnname'>write_raw</a>(&mut self, data: <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#141-151' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Write payload</p>
|
||
<p>This is a low-level function that accepts framed messages that should
|
||
be created using <code>Frame::message()</code>. If you want to send text or binary
|
||
data you should prefer the <code>text()</code> or <code>binary()</code> convenience functions
|
||
that handle the framing for you.</p>
|
||
</div><h4 id='method.state' class="method"><span id='state.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.state' class='fnname'>state</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>S</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#155-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Shared application state</p>
|
||
</div><h4 id='method.request' class="method"><span id='request.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.request' class='fnname'>request</a>(&mut self) -> &mut <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#161-163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Incoming request</p>
|
||
</div><h4 id='method.drain' class="method"><span id='drain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.drain' class='fnname'>drain</a>(&mut self) -> <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#166-170' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns drain future</p>
|
||
</div><h4 id='method.text' class="method"><span id='text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.text' class='fnname'>text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#174-176' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||
</div><h4 id='method.binary' class="method"><span id='binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.binary' class='fnname'>binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#180-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||
</div><h4 id='method.ping' class="method"><span id='ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ping' class='fnname'>ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#186-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||
</div><h4 id='method.pong' class="method"><span id='pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.pong' class='fnname'>pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#197-204' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.close' class='fnname'>close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#208-210' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||
</div><h4 id='method.connected' class="method"><span id='connected.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connected' class='fnname'>connected</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#214-216' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if connection still open</p>
|
||
</div><h4 id='method.handle' class="method"><span id='handle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.handle' class='fnname'>handle</a>(&self) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#231-233' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Handle of the running future</p>
|
||
<p>SpawnHandle is the handle returned by <code>AsyncContext::spawn()</code> method.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-WsWriter' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/ws/trait.WsWriter.html" title="trait actix_web::ws::WsWriter">WsWriter</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>,<br> S: 'static, </span></code><a href='#impl-WsWriter' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#236-270' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.send_text' class="method"><span id='send_text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_text' class='fnname'>send_text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#243-245' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||
</div><h4 id='method.send_binary' class="method"><span id='send_binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_binary' class='fnname'>send_binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#249-251' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||
</div><h4 id='method.send_ping' class="method"><span id='send_ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_ping' class='fnname'>send_ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#255-257' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||
</div><h4 id='method.send_pong' class="method"><span id='send_pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_pong' class='fnname'>send_pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#261-263' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||
</div><h4 id='method.send_close' class="method"><span id='send_close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_close' class='fnname'>send_close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#267-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||
</div></div><h3 id='impl-ActorContext' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.ActorContext.html" title="trait actix_web::actix::actix::dev::ActorContext">ActorContext</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>, </span></code><a href='#impl-ActorContext' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#38-51' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.stop' class="method"><span id='stop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.stop' class='fnname'>stop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#42-44' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immediately stop processing incoming messages and switch to a <code>stopping</code> state <a href="../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.stop">Read more</a></p>
|
||
</div><h4 id='method.terminate' class="method"><span id='terminate.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.terminate' class='fnname'>terminate</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#45-47' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Terminate actor execution</p>
|
||
</div><h4 id='method.state-1' class="method"><span id='state.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.state' class='fnname'>state</a>(&self) -> <a class="enum" href="../../actix_web/actix/actix/enum.ActorState.html" title="enum actix_web::actix::actix::ActorState">ActorState</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Actor execution state</p>
|
||
</div></div><h3 id='impl-AsyncContext%3CA%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/trait.AsyncContext.html" title="trait actix_web::actix::actix::AsyncContext">AsyncContext</a><A> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>, </span></code><a href='#impl-AsyncContext%3CA%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#53-87' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.spawn' class="method"><span id='spawn.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.spawn' class='fnname'>spawn</a><F>(&mut self, fut: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../actix_web/actix/actix/fut/trait.ActorFuture.html" title="trait actix_web::actix::actix::fut::ActorFuture">ActorFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Actor = A> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#57-62' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawn async future into context. Returns handle of the item, could be used for cancelling execution. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.spawn">Read more</a></p>
|
||
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.wait' class='fnname'>wait</a><F>(&mut self, fut: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="../../actix_web/actix/actix/fut/trait.ActorFuture.html" title="trait actix_web::actix::actix::fut::ActorFuture">ActorFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Actor = A> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#64-69' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawn future into the context. Stop processing any of incoming events until this future resolves. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.wait">Read more</a></p>
|
||
</div><h4 id='method.cancel_future' class="method"><span id='cancel_future.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.cancel_future' class='fnname'>cancel_future</a>(&mut self, handle: <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#79-81' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Cancel future. handle is a value returned by <code>spawn</code> method.</p>
|
||
</div><h4 id='method.address' class="method"><span id='address.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.address' class='fnname'>address</a>(&self) -> <a class="struct" href="../../actix_web/actix/actix/struct.Addr.html" title="struct actix_web::actix::actix::Addr">Addr</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#84-86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return <code>Address</code> of the context</p>
|
||
</div><h4 id='tymethod.waiting' class="tymethod"><span id='waiting.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#tymethod.waiting' class='fnname'>waiting</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if context is paused (waiting for future completion or stopping)</p>
|
||
</div><h4 id='method.add_stream' class="method"><span id='add_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.add_stream' class='fnname'>add_stream</a><S>(&mut self, fut: S) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.StreamHandler.html" title="trait actix_web::actix::actix::dev::StreamHandler">StreamHandler</a><<S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, <S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>,<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>This method register stream to an actor context and allows to handle <code>Stream</code> in similar way as normal actor messages. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#method.add_stream">Read more</a></p>
|
||
</div><h4 id='method.add_message_stream' class="method"><span id='add_message_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.add_message_stream' class='fnname'>add_message_stream</a><S>(&mut self, fut: S) <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/trait.Handler.html" title="trait actix_web::actix::actix::Handler">Handler</a><<S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>>,<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + 'static,<br> <S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a>, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>This method is similar to <code>add_stream</code> but it skips stream errors. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#method.add_message_stream">Read more</a></p>
|
||
</div><h4 id='method.notify' class="method"><span id='notify.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.notify' class='fnname'>notify</a><M>(&mut self, msg: M) <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/trait.Handler.html" title="trait actix_web::actix::actix::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Send message <code>msg</code> to self.</p>
|
||
</div><h4 id='method.notify_later' class="method"><span id='notify_later.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.notify_later' class='fnname'>notify_later</a><M>(&mut self, msg: M, after: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/trait.Handler.html" title="trait actix_web::actix::actix::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Send message <code>msg</code> to self after specified period of time. Returns spawn handle which could be used for cancellation. Notification get cancelled if context's stop method get called. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#method.notify_later">Read more</a></p>
|
||
</div><h4 id='method.run_later' class="method"><span id='run_later.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.run_later' class='fnname'>run_later</a><F>(&mut self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>, f: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, &mut <A as <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/dev/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::dev::Actor::Context">Context</a>) + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute closure after specified period of time within same Actor and Context. Execution get cancelled if context's stop method get called. <a href="../../actix_web/actix/actix/trait.AsyncContext.html#method.run_later">Read more</a></p>
|
||
</div><h4 id='method.run_interval' class="method"><span id='run_interval.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.AsyncContext.html#method.run_interval' class='fnname'>run_interval</a><F>(&mut self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>, f: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, &mut <A as <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/dev/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::dev::Actor::Context">Context</a>) + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawns a job to execute the given closure periodically, at a specified fixed interval <a href="../../actix_web/actix/actix/trait.AsyncContext.html#method.run_interval">Read more</a></p>
|
||
</div></div><h3 id='impl-ToEnvelope%3CA%2C%20M%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, M, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.ToEnvelope.html" title="trait actix_web::actix::actix::dev::ToEnvelope">ToEnvelope</a><A, M> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S>> + <a class="trait" href="../../actix_web/actix/actix/trait.Handler.html" title="trait actix_web::actix::actix::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">ActixMessage</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> M::<a class="type" href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result" title="type actix_web::actix::actix::dev::Message::Result">Result</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-ToEnvelope%3CA%2C%20M%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#325-334' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.pack' class="method"><span id='pack.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ToEnvelope.html#tymethod.pack' class='fnname'>pack</a>(msg: M, tx: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/futures/0.1/futures/sync/oneshot/struct.Sender.html" title="struct futures::sync::oneshot::Sender">Sender</a><M::<a class="type" href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result" title="type actix_web::actix::actix::dev::Message::Result">Result</a>>>) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.Envelope.html" title="struct actix_web::actix::actix::dev::Envelope">Envelope</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#331-333' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Pack message into suitable envelope</p>
|
||
</div></div><h3 id='impl-AsyncContextParts%3CA%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.AsyncContextParts.html" title="trait actix_web::actix::actix::dev::AsyncContextParts">AsyncContextParts</a><A> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Actor.html" title="trait actix_web::actix::actix::dev::Actor">Actor</a><Context = Self>, </span></code><a href='#impl-AsyncContextParts%3CA%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#272-279' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.parts' class="method"><span id='parts.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContextParts.html#tymethod.parts' class='fnname'>parts</a>(&mut self) -> &mut <a class="struct" href="../../actix_web/actix/actix/dev/struct.ContextParts.html" title="struct actix_web::actix::actix::dev::ContextParts">ContextParts</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#276-278' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></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, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> !<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.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S></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, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> !<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.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S></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><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#462-464' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#463' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Into' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#453-458' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#455-457' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryFrom' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><U>, </span></code><a href='#impl-TryFrom' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#481-487' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a></code></span></h4>
|
||
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method"><span id='try_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#484-486' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Borrow' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219-221' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow' class="method"><span id='borrow.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id='impl-BorrowMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#224-226' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method"><span id='borrow_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#225' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id='impl-TryInto' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#469-476' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><span id='Error.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></span></h4>
|
||
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method"><span id='try_into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#473-475' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Any' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#114-116' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_type_id' class="method"><span id='get_type_id.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id' class='fnname'>get_type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>get_type_id</code>)</summary><p>this method will likely be replaced by an associated static</p>
|
||
</details></div></div><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id">Read more</a></p>
|
||
</div></div><h3 id='impl-Erased' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> Erased for T</code><a href='#impl-Erased' 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> |