1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-04-23 18:33:21 +02:00
actix-extras/src/actix_session/session.rs.html

652 lines
28 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Source of the Rust file `actix-session/src/session.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>session.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc source"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container">
<img src="https://actix.rs/img/logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_session/index.html">
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::{
cell::{Ref, RefCell},
collections::HashMap,
error::Error <span class="kw">as </span>StdError,
mem,
rc::Rc,
};
<span class="kw">use </span>actix_utils::future::{ready, Ready};
<span class="kw">use </span>actix_web::{
body::BoxBody,
dev::{Extensions, Payload, ServiceRequest, ServiceResponse},
error::Error,
FromRequest, HttpMessage, HttpRequest, HttpResponse, ResponseError,
};
<span class="kw">use </span>anyhow::Context;
<span class="kw">use </span>derive_more::{Display, From};
<span class="kw">use </span>serde::{de::DeserializeOwned, Serialize};
<span class="doccomment">/// The primary interface to access and modify session state.
///
/// [`Session`] is an [extractor](#impl-FromRequest)—you can specify it as an input type for your
/// request handlers and it will be automatically extracted from the incoming request.
///
/// ```
/// use actix_session::Session;
///
/// async fn index(session: Session) -&gt; actix_web::Result&lt;&amp;&#39;static str&gt; {
/// // access session data
/// if let Some(count) = session.get::&lt;i32&gt;(&quot;counter&quot;)? {
/// session.insert(&quot;counter&quot;, count + 1)?;
/// } else {
/// session.insert(&quot;counter&quot;, 1)?;
/// }
///
/// Ok(&quot;Welcome!&quot;)
/// }
/// # actix_web::web::to(index);
/// ```
///
/// You can also retrieve a [`Session`] object from an `HttpRequest` or a `ServiceRequest` using
/// [`SessionExt`].
///
/// [`SessionExt`]: crate::SessionExt
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Session(Rc&lt;RefCell&lt;SessionInner&gt;&gt;);
<span class="doccomment">/// Status of a [`Session`].
</span><span class="attribute">#[derive(Debug, Clone, PartialEq, Eq)]
</span><span class="kw">pub enum </span>SessionStatus {
<span class="doccomment">/// Session state has been updated - the changes will have to be persisted to the backend.
</span>Changed,
<span class="doccomment">/// The session has been flagged for deletion - the session cookie will be removed from
/// the client and the session state will be deleted from the session store.
///
/// Most operations on the session after it has been marked for deletion will have no effect.
</span>Purged,
<span class="doccomment">/// The session has been flagged for renewal.
///
/// The session key will be regenerated and the time-to-live of the session state will be
/// extended.
</span>Renewed,
<span class="doccomment">/// The session state has not been modified since its creation/retrieval.
</span>Unchanged,
}
<span class="kw">impl </span>Default <span class="kw">for </span>SessionStatus {
<span class="kw">fn </span>default() -&gt; SessionStatus {
SessionStatus::Unchanged
}
}
<span class="attribute">#[derive(Default)]
</span><span class="kw">struct </span>SessionInner {
state: HashMap&lt;String, String&gt;,
status: SessionStatus,
}
<span class="kw">impl </span>Session {
<span class="doccomment">/// Get a `value` from the session.
///
/// It returns an error if it fails to deserialize as `T` the JSON value associated with `key`.
</span><span class="kw">pub fn </span>get&lt;T: DeserializeOwned&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;T&gt;, SessionGetError&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(val_str) = <span class="self">self</span>.<span class="number">0</span>.borrow().state.get(key) {
<span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(
serde_json::from_str(val_str)
.with_context(|| {
<span class="macro">format!</span>(
<span class="string">&quot;Failed to deserialize the JSON-encoded session data attached to key \
`{}` as a `{}` type&quot;</span>,
key,
std::any::type_name::&lt;T&gt;()
)
})
.map_err(SessionGetError)<span class="question-mark">?</span>,
))
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
}
}
<span class="doccomment">/// Get all raw key-value data from the session.
///
/// Note that values are JSON encoded.
</span><span class="kw">pub fn </span>entries(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Ref&lt;<span class="lifetime">&#39;_</span>, HashMap&lt;String, String&gt;&gt; {
Ref::map(<span class="self">self</span>.<span class="number">0</span>.borrow(), |inner| <span class="kw-2">&amp;</span>inner.state)
}
<span class="doccomment">/// Returns session status.
</span><span class="kw">pub fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; SessionStatus {
Ref::map(<span class="self">self</span>.<span class="number">0</span>.borrow(), |inner| <span class="kw-2">&amp;</span>inner.status).clone()
}
<span class="doccomment">/// Inserts a key-value pair into the session.
///
/// Any serializable value can be used and will be encoded as JSON in session data, hence why
/// only a reference to the value is taken.
///
/// It returns an error if it fails to serialize `value` to JSON.
</span><span class="kw">pub fn </span>insert&lt;T: Serialize&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
key: <span class="kw">impl </span>Into&lt;String&gt;,
value: T,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), SessionInsertError&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.<span class="number">0</span>.borrow_mut();
<span class="kw">if </span>inner.status != SessionStatus::Purged {
<span class="kw">if </span>inner.status != SessionStatus::Renewed {
inner.status = SessionStatus::Changed;
}
<span class="kw">let </span>key = key.into();
<span class="kw">let </span>val = serde_json::to_string(<span class="kw-2">&amp;</span>value)
.with_context(|| {
<span class="macro">format!</span>(
<span class="string">&quot;Failed to serialize the provided `{}` type instance as JSON in order to \
attach as session data to the `{}` key&quot;</span>,
std::any::type_name::&lt;T&gt;(),
<span class="kw-2">&amp;</span>key
)
})
.map_err(SessionInsertError)<span class="question-mark">?</span>;
inner.state.insert(key, val);
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Remove value from the session.
///
/// If present, the JSON encoded value is returned.
</span><span class="kw">pub fn </span>remove(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.<span class="number">0</span>.borrow_mut();
<span class="kw">if </span>inner.status != SessionStatus::Purged {
<span class="kw">if </span>inner.status != SessionStatus::Renewed {
inner.status = SessionStatus::Changed;
}
<span class="kw">return </span>inner.state.remove(key);
}
<span class="prelude-val">None
</span>}
<span class="doccomment">/// Remove value from the session and deserialize.
///
/// Returns `None` if key was not present in session. Returns `T` if deserialization succeeds,
/// otherwise returns un-deserialized JSON string.
</span><span class="kw">pub fn </span>remove_as&lt;T: DeserializeOwned&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Result</span>&lt;T, String&gt;&gt; {
<span class="self">self</span>.remove(key)
.map(|val_str| <span class="kw">match </span>serde_json::from_str(<span class="kw-2">&amp;</span>val_str) {
<span class="prelude-val">Ok</span>(val) =&gt; <span class="prelude-val">Ok</span>(val),
<span class="prelude-val">Err</span>(_err) =&gt; {
<span class="macro">tracing::debug!</span>(
<span class="string">&quot;Removed value (key: {}) could not be deserialized as {}&quot;</span>,
key,
std::any::type_name::&lt;T&gt;()
);
<span class="prelude-val">Err</span>(val_str)
}
})
}
<span class="doccomment">/// Clear the session.
</span><span class="kw">pub fn </span>clear(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.<span class="number">0</span>.borrow_mut();
<span class="kw">if </span>inner.status != SessionStatus::Purged {
<span class="kw">if </span>inner.status != SessionStatus::Renewed {
inner.status = SessionStatus::Changed;
}
inner.state.clear()
}
}
<span class="doccomment">/// Removes session both client and server side.
</span><span class="kw">pub fn </span>purge(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.<span class="number">0</span>.borrow_mut();
inner.status = SessionStatus::Purged;
inner.state.clear();
}
<span class="doccomment">/// Renews the session key, assigning existing session state to new key.
</span><span class="kw">pub fn </span>renew(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.<span class="number">0</span>.borrow_mut();
<span class="kw">if </span>inner.status != SessionStatus::Purged {
inner.status = SessionStatus::Renewed;
}
}
<span class="doccomment">/// Adds the given key-value pairs to the session on the request.
///
/// Values that match keys already existing on the session will be overwritten. Values should
/// already be JSON serialized.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_session(
req: <span class="kw-2">&amp;mut </span>ServiceRequest,
data: <span class="kw">impl </span>IntoIterator&lt;Item = (String, String)&gt;,
) {
<span class="kw">let </span>session = Session::get_session(<span class="kw-2">&amp;mut *</span>req.extensions_mut());
<span class="kw">let </span><span class="kw-2">mut </span>inner = session.<span class="number">0</span>.borrow_mut();
inner.state.extend(data);
}
<span class="doccomment">/// Returns session status and iterator of key-value pairs of changes.
///
/// This is a destructive operation - the session state is removed from the request extensions
/// typemap, leaving behind a new empty map. It should only be used when the session is being
/// finalised (i.e. in `SessionMiddleware`).
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_changes&lt;B&gt;(
res: <span class="kw-2">&amp;mut </span>ServiceResponse&lt;B&gt;,
) -&gt; (SessionStatus, HashMap&lt;String, String&gt;) {
<span class="kw">if let </span><span class="prelude-val">Some</span>(s_impl) = res
.request()
.extensions()
.get::&lt;Rc&lt;RefCell&lt;SessionInner&gt;&gt;&gt;()
{
<span class="kw">let </span>state = mem::take(<span class="kw-2">&amp;mut </span>s_impl.borrow_mut().state);
(s_impl.borrow().status.clone(), state)
} <span class="kw">else </span>{
(SessionStatus::Unchanged, HashMap::new())
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_session(extensions: <span class="kw-2">&amp;mut </span>Extensions) -&gt; Session {
<span class="kw">if let </span><span class="prelude-val">Some</span>(s_impl) = extensions.get::&lt;Rc&lt;RefCell&lt;SessionInner&gt;&gt;&gt;() {
<span class="kw">return </span>Session(Rc::clone(s_impl));
}
<span class="kw">let </span>inner = Rc::new(RefCell::new(SessionInner::default()));
extensions.insert(inner.clone());
Session(inner)
}
}
<span class="doccomment">/// Extractor implementation for [`Session`]s.
///
/// # Examples
/// ```
/// # use actix_web::*;
/// use actix_session::Session;
///
/// #[get(&quot;/&quot;)]
/// async fn index(session: Session) -&gt; Result&lt;impl Responder&gt; {
/// // access session data
/// if let Some(count) = session.get::&lt;i32&gt;(&quot;counter&quot;)? {
/// session.insert(&quot;counter&quot;, count + 1)?;
/// } else {
/// session.insert(&quot;counter&quot;, 1)?;
/// }
///
/// let count = session.get::&lt;i32&gt;(&quot;counter&quot;)?.unwrap();
/// Ok(format!(&quot;Counter: {}&quot;, count))
/// }
/// ```
</span><span class="kw">impl </span>FromRequest <span class="kw">for </span>Session {
<span class="kw">type </span>Error = Error;
<span class="kw">type </span>Future = Ready&lt;<span class="prelude-ty">Result</span>&lt;Session, Error&gt;&gt;;
<span class="attribute">#[inline]
</span><span class="kw">fn </span>from_request(req: <span class="kw-2">&amp;</span>HttpRequest, <span class="kw">_</span>: <span class="kw-2">&amp;mut </span>Payload) -&gt; <span class="self">Self</span>::Future {
ready(<span class="prelude-val">Ok</span>(Session::get_session(<span class="kw-2">&amp;mut *</span>req.extensions_mut())))
}
}
<span class="doccomment">/// Error returned by [`Session::get`].
</span><span class="attribute">#[derive(Debug, Display, From)]
#[display(fmt = <span class="string">&quot;{}&quot;</span>, _0)]
</span><span class="kw">pub struct </span>SessionGetError(anyhow::Error);
<span class="kw">impl </span>StdError <span class="kw">for </span>SessionGetError {
<span class="kw">fn </span>source(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>(<span class="kw">dyn </span>StdError + <span class="lifetime">&#39;static</span>)&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>.as_ref())
}
}
<span class="kw">impl </span>ResponseError <span class="kw">for </span>SessionGetError {
<span class="kw">fn </span>error_response(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; HttpResponse&lt;BoxBody&gt; {
HttpResponse::new(<span class="self">self</span>.status_code())
}
}
<span class="doccomment">/// Error returned by [`Session::insert`].
</span><span class="attribute">#[derive(Debug, Display, From)]
#[display(fmt = <span class="string">&quot;{}&quot;</span>, _0)]
</span><span class="kw">pub struct </span>SessionInsertError(anyhow::Error);
<span class="kw">impl </span>StdError <span class="kw">for </span>SessionInsertError {
<span class="kw">fn </span>source(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>(<span class="kw">dyn </span>StdError + <span class="lifetime">&#39;static</span>)&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>.as_ref())
}
}
<span class="kw">impl </span>ResponseError <span class="kw">for </span>SessionInsertError {
<span class="kw">fn </span>error_response(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; HttpResponse&lt;BoxBody&gt; {
HttpResponse::new(<span class="self">self</span>.status_code())
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (9062b780b 2022-09-21)" ></div></body></html>