mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-24 07:53:00 +01:00
8 lines
9.7 KiB
HTML
8 lines
9.7 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="Extract a `Session` object from various `actix-web` types (e.g. `HttpRequest`, `ServiceRequest`, `ServiceResponse`)."><title>SessionExt in actix_session - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-804b98a1284a310a.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_session" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0-nightly (6a6287132 2023-12-17)" data-channel="nightly" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.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">☰</button><a class="logo-container" href="../actix_session/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_session/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_session/index.html">actix_session</a><span class="version">0.8.0</span></h2></div><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'a%3E">GuardContext<'a></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 crate actix_session</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../actix_session/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</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-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">actix_session</a>::<wbr><a class="trait" href="#">SessionExt</a><button id="copy-path" 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="src" href="../src/actix_session/session_ext.rs.html#11-14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SessionExt {
|
||
// Required method
|
||
fn <a href="#tymethod.get_session" class="fn">get_session</a>(&self) -> <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extract a <a href="struct.Session.html" title="struct actix_session::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="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.get_session" class="method"><a class="src rightside" href="../src/actix_session/session_ext.rs.html#13">source</a><h4 class="code-header">fn <a href="#tymethod.get_session" class="fn">get_session</a>(&self) -> <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="struct actix_session::Session"><code>Session</code></a> object.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-SessionExt-for-HttpRequest" class="impl"><a class="src 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"><a class="src 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="fn">get_session</a>(&self) -> <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceRequest" class="impl"><a class="src 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"><a class="src 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="fn">get_session</a>(&self) -> <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-SessionExt-for-ServiceResponse" class="impl"><a class="src 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"><a class="src 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="fn">get_session</a>(&self) -> <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-SessionExt-for-GuardContext%3C'a%3E" class="impl"><a class="src rightside" href="../src/actix_session/session_ext.rs.html#34-38">source</a><a href="#impl-SessionExt-for-GuardContext%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.SessionExt.html" title="trait actix_session::SessionExt">SessionExt</a> for GuardContext<'a></h3></section></summary><div class="impl-items"><section id="method.get_session-3" class="method trait-impl"><a class="src 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="fn">get_session</a>(&self) -> <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/actix_session/session_ext/trait.SessionExt.js" data-ignore-extern-crates="actix_web" async></script></section></div></main></body></html> |