actix-extras/actix_session/trait.SessionExt.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="Extract a [`Session`] object from various `actix-web` types (e.g. `HttpRequest`, `ServiceRequest`, `ServiceResponse`)."><meta name="keywords" content="rust, rustlang, rust-lang, SessionExt"><title>SessionExt in actix_session - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc trait"><!--[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></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><h2 class="location"><a href="#">SessionExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_session">get_session</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SessionExt-for-GuardContext%3C%27a%3E">GuardContext&lt;&#39;a&gt;</a></li><li><a href="#impl-SessionExt-for-HttpRequest">HttpRequest</a></li><li><a href="#impl-SessionExt-for-ServiceRequest">ServiceRequest</a></li><li><a href="#impl-SessionExt-for-ServiceResponse">ServiceResponse</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In actix_session</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">actix_session</a>::<wbr><a class="trait" href="#">SessionExt</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/actix_session/session_ext.rs.html#11-14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SessionExt {
    fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extract a <a href="struct.Session.html" title="Session"><code>Session</code></a> object from various <code>actix-web</code> types (e.g. <code>HttpRequest</code>,
<code>ServiceRequest</code>, <code>ServiceResponse</code>).</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.get_session" class="method has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#13">source</a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></summary><div class="docblock"><p>Extract a <a href="struct.Session.html" title="Session"><code>Session</code></a> object.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-HttpRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#16-20">source</a><a href="#impl-SessionExt-for-HttpRequest" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for HttpRequest</h3></section></summary><div class="impl-items"><section id="method.get_session" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#17-19">source</a><a href="#method.get_session" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#22-26">source</a><a href="#impl-SessionExt-for-ServiceRequest" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for ServiceRequest</h3></section></summary><div class="impl-items"><section id="method.get_session-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#23-25">source</a><a href="#method.get_session-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceResponse" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#28-32">source</a><a href="#impl-SessionExt-for-ServiceResponse" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for ServiceResponse</h3></section></summary><div class="impl-items"><section id="method.get_session-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#29-31">source</a><a href="#method.get_session-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-GuardContext%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#34-38">source</a><a href="#impl-SessionExt-for-GuardContext%3C%27a%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for GuardContext&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="method.get_session-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#35-37">source</a><a href="#method.get_session-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="..
-												Deploying to gh-pages from  @ 8e76c6c6288df577ef437c08c7110273bc702fee 🚀

											
										
										
											2022-11-12 14:34:14 +01:00
+								<!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="Extract a [`Session`] object from various `actix-web` types (e.g. `HttpRequest`, `ServiceRequest`, `ServiceResponse`)."><meta name="keywords" content="rust, rustlang, rust-lang, SessionExt"><title>SessionExt in actix_session - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc trait"><!--[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></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../actix_session/index.html"><div class="logo-container">
-												Deploying to gh-pages from  @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀

											
										
										
											2022-11-08 10:33:31 +01:00
+								                    <img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"><a href="#">SessionExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_session">get_session</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SessionExt-for-GuardContext%3C%27a%3E">GuardContext&lt;&#39;a&gt;</a></li><li><a href="#impl-SessionExt-for-HttpRequest">HttpRequest</a></li><li><a href="#impl-SessionExt-for-ServiceRequest">ServiceRequest</a></li><li><a href="#impl-SessionExt-for-ServiceResponse">ServiceResponse</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In actix_session</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">actix_session</a>::<wbr><a class="trait" href="#">SessionExt</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/actix_session/session_ext.rs.html#11-14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SessionExt {
-												Deploying to gh-pages from  @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀

											
										
										
											2022-03-06 00:25:11 +01:00
+								    fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a>;
 								}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extract a <a href="struct.Session.html" title="Session"><code>Session</code></a> object from various <code>actix-web</code> types (e.g. <code>HttpRequest</code>,
 								<code>ServiceRequest</code>, <code>ServiceResponse</code>).</p>
-												Deploying to gh-pages from  @ fb8a814acb3166ac6c44a49b7e8895cc00e8c564 🚀

											
										
										
											2022-10-15 13:40:31 +02:00
+								</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.get_session" class="method has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#13">source</a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></summary><div class="docblock"><p>Extract a <a href="struct.Session.html" title="Session"><code>Session</code></a> object.</p>
-												Deploying to gh-pages from  @ 8e76c6c6288df577ef437c08c7110273bc702fee 🚀

											
										
										
											2022-11-12 14:34:14 +01:00
+								</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-HttpRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#16-20">source</a><a href="#impl-SessionExt-for-HttpRequest" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for HttpRequest</h3></section></summary><div class="impl-items"><section id="method.get_session" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#17-19">source</a><a href="#method.get_session" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#22-26">source</a><a href="#impl-SessionExt-for-ServiceRequest" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for ServiceRequest</h3></section></summary><div class="impl-items"><section id="method.get_session-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#23-25">source</a><a href="#method.get_session-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceResponse" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#28-32">source</a><a href="#impl-SessionExt-for-ServiceResponse" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for ServiceResponse</h3></section></summary><div class="impl-items"><section id="method.get_session-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#29-31">source</a><a href="#method.get_session-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SessionExt-for-GuardContext%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#34-38">source</a><a href="#impl-SessionExt-for-GuardContext%3C%27a%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for GuardContext&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="method.get_session-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/session_ext.rs.html#35-37">source</a><a href="#method.get_session-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&amp;self) -&gt; <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="..