1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-25 00:12:59 +01:00
actix-extras/actix_session/trait.SessionExt.html
2022-03-25 18:28:02 +00:00

15 lines
11 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="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="../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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.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 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 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><h2 class="location"><a href="#">SessionExt</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.get_session">get_session</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><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></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In actix_session</a></h2><div id="sidebar-vars" data-name="SessionExt" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></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"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">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="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/actix_session/session_ext.rs.html#11-14">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock 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" open><summary><div id="tymethod.get_session" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#13">source</a></div><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></div></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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#16-20">source</a></span><a href="#impl-SessionExt-for-HttpRequest" class="anchor"></a><h3 class="code-header in-band">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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#17-19">source</a></span><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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#22-26">source</a></span><a href="#impl-SessionExt-for-ServiceRequest" class="anchor"></a><h3 class="code-header in-band">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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#23-25">source</a></span><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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#28-32">source</a></span><a href="#impl-SessionExt-for-ServiceResponse" class="anchor"></a><h3 class="code-header in-band">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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#29-31">source</a></span><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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#34-38">source</a></span><a href="#impl-SessionExt-for-GuardContext%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">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"><span class="rightside"><a class="srclink" href="../src/actix_session/session_ext.rs.html#35-37">source</a></span><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 class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/actix_session/trait.SessionExt.js" async></script></section><section id="search" class="content hidden"></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.61.0-nightly (63b8f01bb 2022-03-24)" ></div>
</body></html>