mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-23 16:21:06 +01:00
102 lines
42 KiB
HTML
102 lines
42 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="Execution context for HTTP actors"><title>HttpContext in actix_web_actors - 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 struct"><!--[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><h2 class="location"><a href="#">HttpContext</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.create">create</a></li><li><a href="#method.handle">handle</a></li><li><a href="#method.with_factory">with_factory</a></li><li><a href="#method.write">write</a></li><li><a href="#method.write_eof">write_eof</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-ActorContext-for-HttpContext%3CA%3E">ActorContext</a></li><li><a href="#impl-AsyncContext%3CA%3E-for-HttpContext%3CA%3E">AsyncContext<A></a></li><li><a href="#impl-AsyncContextParts%3CA%3E-for-HttpContext%3CA%3E">AsyncContextParts<A></a></li><li><a href="#impl-ToEnvelope%3CA,+M%3E-for-HttpContext%3CA%3E">ToEnvelope<A, M></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-HttpContext%3CA%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-HttpContext%3CA%3E">!Send</a></li><li><a href="#impl-Sync-for-HttpContext%3CA%3E">!Sync</a></li><li><a href="#impl-UnwindSafe-for-HttpContext%3CA%3E">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-HttpContext%3CA%3E">Freeze</a></li><li><a href="#impl-Unpin-for-HttpContext%3CA%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip<V></a></li><li><a href="#impl-WithSubscriber-for-T">WithSubscriber</a></li></ul></section><h2><a href="index.html">In crate actix_web_actors</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>Struct <a href="index.html">actix_web_actors</a>::<wbr><a class="struct" href="#">HttpContext</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/context.rs.html#71-77">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct HttpContext<A><div class="where">where
|
|
A: Actor<Context = <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A>>,</div>{ <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Execution context for HTTP actors</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<p>A demonstration of <a href="https://developer.mozilla.org/docs/Web/API/Server-sent_events">server-sent events</a> using actors:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">use </span>actix::{Actor, AsyncContext};
|
|
<span class="kw">use </span>actix_web::{get, http::header, App, HttpResponse, HttpServer};
|
|
<span class="kw">use </span>actix_web_actors::HttpContext;
|
|
<span class="kw">use </span>bytes::Bytes;
|
|
|
|
<span class="kw">struct </span>MyActor {
|
|
count: usize,
|
|
}
|
|
|
|
<span class="kw">impl </span>Actor <span class="kw">for </span>MyActor {
|
|
<span class="kw">type </span>Context = HttpContext<<span class="self">Self</span>>;
|
|
|
|
<span class="kw">fn </span>started(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&mut </span><span class="self">Self</span>::Context) {
|
|
ctx.run_later(Duration::from_millis(<span class="number">100</span>), <span class="self">Self</span>::write);
|
|
}
|
|
}
|
|
|
|
<span class="kw">impl </span>MyActor {
|
|
<span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&mut </span>HttpContext<<span class="self">Self</span>>) {
|
|
<span class="self">self</span>.count += <span class="number">1</span>;
|
|
<span class="kw">if </span><span class="self">self</span>.count > <span class="number">3 </span>{
|
|
ctx.write_eof()
|
|
} <span class="kw">else </span>{
|
|
ctx.write(Bytes::from(<span class="macro">format!</span>(<span class="string">"event: count\ndata: {}\n\n"</span>, <span class="self">self</span>.count)));
|
|
ctx.run_later(Duration::from_millis(<span class="number">100</span>), <span class="self">Self</span>::write);
|
|
}
|
|
}
|
|
}
|
|
|
|
<span class="attr">#[get(<span class="string">"/"</span>)]
|
|
</span><span class="kw">async fn </span>index() -> HttpResponse {
|
|
HttpResponse::Ok()
|
|
.insert_header(header::ContentType(mime::TEXT_EVENT_STREAM))
|
|
.streaming(HttpContext::create(MyActor { count: <span class="number">0 </span>}))
|
|
}
|
|
|
|
<span class="attr">#[actix_web::main]
|
|
</span><span class="kw">async fn </span>main() -> std::io::Result<()> {
|
|
HttpServer::new(|| App::new().service(index))
|
|
.bind((<span class="string">"127.0.0.1"</span>, <span class="number">8080</span>))<span class="question-mark">?
|
|
</span>.run()
|
|
.<span class="kw">await
|
|
</span>}</code></pre></div>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-HttpContext%3CA%3E" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#133-162">source</a><a href="#impl-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = Self>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.create" class="method"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#139-146">source</a><h4 class="code-header">pub fn <a href="#method.create" class="fn">create</a>(actor: A) -> impl 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, Error>></h4></section></summary><div class="docblock"><p>Create a new HTTP Context from a request and an actor</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_factory" class="method"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#149-161">source</a><h4 class="code-header">pub fn <a href="#method.with_factory" class="fn">with_factory</a><F>(f: F) -> impl 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, Error>><div class="where">where
|
|
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 Self</a>) -> A + 'static,</div></h4></section></summary><div class="docblock"><p>Create a new HTTP Context</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-HttpContext%3CA%3E-1" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#164-186">source</a><a href="#impl-HttpContext%3CA%3E-1" class="anchor">§</a><h3 class="code-header">impl<A> <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = Self>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#170-172">source</a><h4 class="code-header">pub fn <a href="#method.write" class="fn">write</a>(&mut self, data: Bytes)</h4></section></summary><div class="docblock"><p>Write payload</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_eof" class="method"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#176-178">source</a><h4 class="code-header">pub fn <a href="#method.write_eof" class="fn">write_eof</a>(&mut self)</h4></section></summary><div class="docblock"><p>Indicate end of streaming payload. Also this method calls <code>Self::close</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.handle" class="method"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#183-185">source</a><h4 class="code-header">pub fn <a href="#method.handle" class="fn">handle</a>(&self) -> SpawnHandle</h4></section></summary><div class="docblock"><p>Handle of the running future</p>
|
|
<p>SpawnHandle is the handle returned by <code>AsyncContext::spawn()</code> method.</p>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ActorContext-for-HttpContext%3CA%3E" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#79-92">source</a><a href="#impl-ActorContext-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> ActorContext for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = Self>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.stop" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#83-85">source</a><a href="#method.stop" class="anchor">§</a><h4 class="code-header">fn <a class="fn">stop</a>(&mut self)</h4></section></summary><div class='docblock'>Immediately stop processing incoming messages and switch to a
|
|
<code>stopping</code> state. This only affects actors that are currently
|
|
<code>running</code>. Future attempts to queue messages will fail.</div></details><details class="toggle method-toggle" open><summary><section id="method.terminate" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#86-88">source</a><a href="#method.terminate" class="anchor">§</a><h4 class="code-header">fn <a class="fn">terminate</a>(&mut self)</h4></section></summary><div class='docblock'>Terminate actor execution unconditionally. This sets the actor
|
|
into the <code>stopped</code> state. This causes future attempts to queue
|
|
messages to fail.</div></details><details class="toggle method-toggle" open><summary><section id="method.state" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#89-91">source</a><a href="#method.state" class="anchor">§</a><h4 class="code-header">fn <a class="fn">state</a>(&self) -> ActorState</h4></section></summary><div class='docblock'>Retrieve the current Actor execution state.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsyncContext%3CA%3E-for-HttpContext%3CA%3E" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#94-131">source</a><a href="#impl-AsyncContext%3CA%3E-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> AsyncContext<A> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = Self>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.spawn" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#99-104">source</a><a href="#method.spawn" class="anchor">§</a><h4 class="code-header">fn <a class="fn">spawn</a><F>(&mut self, fut: F) -> SpawnHandle<div class="where">where
|
|
F: ActorFuture<A, Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + 'static,</div></h4></section></summary><div class='docblock'>Spawns a future into the context. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.wait" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#107-112">source</a><a href="#method.wait" class="anchor">§</a><h4 class="code-header">fn <a class="fn">wait</a><F>(&mut self, fut: F)<div class="where">where
|
|
F: ActorFuture<A, Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + 'static,</div></h4></section></summary><div class='docblock'>Spawns a future into the context, waiting for it to resolve. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.cancel_future" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#123-125">source</a><a href="#method.cancel_future" class="anchor">§</a><h4 class="code-header">fn <a class="fn">cancel_future</a>(&mut self, handle: SpawnHandle) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Cancels a spawned future. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.address" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#128-130">source</a><a href="#method.address" class="anchor">§</a><h4 class="code-header">fn <a class="fn">address</a>(&self) -> Addr<A></h4></section></summary><div class='docblock'>Returns the address of the context.</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.waiting" class="tymethod trait-impl"><a href="#tymethod.waiting" class="anchor">§</a><h4 class="code-header">fn <a class="fn">waiting</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Checks if the context is paused (waiting for future completion or stopping).</div></details><details class="toggle method-toggle" open><summary><section id="method.add_stream" class="method trait-impl"><a href="#method.add_stream" class="anchor">§</a><h4 class="code-header">fn <a class="fn">add_stream</a><S>(&mut self, fut: S) -> SpawnHandle<div class="where">where
|
|
S: Stream + 'static,
|
|
A: StreamHandler<<S as Stream>::Item>,</div></h4></section></summary><div class='docblock'>Registers a stream with the context. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.add_message_stream" class="method trait-impl"><a href="#method.add_message_stream" class="anchor">§</a><h4 class="code-header">fn <a class="fn">add_message_stream</a><S>(&mut self, fut: S)<div class="where">where
|
|
S: Stream + 'static,
|
|
<S as Stream>::Item: Message,
|
|
A: Handler<<S as Stream>::Item>,</div></h4></section></summary><div class='docblock'>Registers a stream with the context, ignoring errors. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.notify" class="method trait-impl"><a href="#method.notify" class="anchor">§</a><h4 class="code-header">fn <a class="fn">notify</a><M>(&mut self, msg: M)<div class="where">where
|
|
A: Handler<M>,
|
|
M: Message + 'static,</div></h4></section></summary><div class='docblock'>Sends the message <code>msg</code> to self. This bypasses the mailbox capacity, and
|
|
will always queue the message. If the actor is in the <code>stopped</code> state, an
|
|
error will be raised.</div></details><details class="toggle method-toggle" open><summary><section id="method.notify_later" class="method trait-impl"><a href="#method.notify_later" class="anchor">§</a><h4 class="code-header">fn <a class="fn">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>) -> SpawnHandle<div class="where">where
|
|
A: Handler<M>,
|
|
M: Message + 'static,</div></h4></section></summary><div class='docblock'>Sends the message <code>msg</code> to self after a specified period of time. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.run_later" class="method trait-impl"><a href="#method.run_later" class="anchor">§</a><h4 class="code-header">fn <a class="fn">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) -> SpawnHandle<div class="where">where
|
|
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 Actor>::Context) + 'static,</div></h4></section></summary><div class='docblock'>Executes a closure after a specified period of time. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.run_interval" class="method trait-impl"><a href="#method.run_interval" class="anchor">§</a><h4 class="code-header">fn <a class="fn">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) -> SpawnHandle<div class="where">where
|
|
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 Actor>::Context) + 'static,</div></h4></section></summary><div class='docblock'>Spawns a job to execute the given closure periodically, at a
|
|
specified fixed interval.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsyncContextParts%3CA%3E-for-HttpContext%3CA%3E" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#188-195">source</a><a href="#impl-AsyncContextParts%3CA%3E-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> AsyncContextParts<A> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = Self>,</div></h3></section></summary><div class="impl-items"><section id="method.parts" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#192-194">source</a><a href="#method.parts" class="anchor">§</a><h4 class="code-header">fn <a class="fn">parts</a>(&mut self) -> &mut ContextParts<A></h4></section></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ToEnvelope%3CA,+M%3E-for-HttpContext%3CA%3E" class="impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#236-245">source</a><a href="#impl-ToEnvelope%3CA,+M%3E-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A, M> ToEnvelope<A, M> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A><div class="where">where
|
|
A: Actor<Context = <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A>> + Handler<M>,
|
|
M: Message + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
|
M::Result: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.pack" class="method trait-impl"><a class="src rightside" href="../src/actix_web_actors/context.rs.html#242-244">source</a><a href="#method.pack" class="anchor">§</a><h4 class="code-header">fn <a class="fn">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><Sender<M::Result>>) -> Envelope<A></h4></section></summary><div class='docblock'>Pack message into suitable envelope</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-HttpContext%3CA%3E" class="impl"><a href="#impl-Freeze-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section><section id="impl-RefUnwindSafe-for-HttpContext%3CA%3E" class="impl"><a href="#impl-RefUnwindSafe-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section><section id="impl-Send-for-HttpContext%3CA%3E" class="impl"><a href="#impl-Send-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<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="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section><section id="impl-Sync-for-HttpContext%3CA%3E" class="impl"><a href="#impl-Sync-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<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="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section><section id="impl-Unpin-for-HttpContext%3CA%3E" class="impl"><a href="#impl-Unpin-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section><section id="impl-UnwindSafe-for-HttpContext%3CA%3E" class="impl"><a href="#impl-UnwindSafe-for-HttpContext%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.HttpContext.html" title="struct actix_web_actors::HttpContext">HttpContext</a><A></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">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<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">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></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl<T> Instrument for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a class="fn">instrument</a>(self, span: Span) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
|
|
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a class="fn">in_current_span</a>(self) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="super::Span::current()">current</a> <a href="crate::Span"><code>Span</code></a>, returning an
|
|
<code>Instrumented</code> wrapper. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">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><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Same-for-T" class="impl"><a class="src rightside" href="https://docs.rs/typenum/1.17.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a> for T</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html#associatedtype.Output" class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>Should always be <code>Self</code></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">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><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">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><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<V, T> VZip<V> for T<div class="where">where
|
|
V: MultiLane<T>,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">vzip</a>(self) -> V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl<T> WithSubscriber for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_subscriber</a><S>(self, subscriber: S) -> WithDispatch<Self><div class="where">where
|
|
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
|
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><div class='docblock'>Attaches the current <a href="crate::dispatcher#setting-the-default-subscriber">default</a> <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
|
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details></div></section></div></main></body></html> |