mirror of
https://github.com/actix/actix-extras.git
synced 2025-08-31 19:37:00 +02:00
Deploying to gh-pages from @ 23912afd49 🚀
This commit is contained in:
robjtede
10
actix_identity/cookie/struct.CookieIdentityPolicy.html
Normal file
10
actix_identity/cookie/struct.CookieIdentityPolicy.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../actix_identity/struct.CookieIdentityPolicy.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../actix_identity/struct.CookieIdentityPolicy.html">../../actix_identity/struct.CookieIdentityPolicy.html</a>...</p>
|
||||
<script>location.replace("../../actix_identity/struct.CookieIdentityPolicy.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
actix_identity/identity/struct.Identity.html
Normal file
10
actix_identity/identity/struct.Identity.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../actix_identity/struct.Identity.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../actix_identity/struct.Identity.html">../../actix_identity/struct.Identity.html</a>...</p>
|
||||
<script>location.replace("../../actix_identity/struct.Identity.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,20 +1,17 @@
|
||||
<!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="Request identity service for Actix applications."><meta name="keywords" content="rust, rustlang, rust-lang, actix_identity"><title>actix_identity - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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="Opinionated request identity service for Actix Web apps."><meta name="keywords" content="rust, rustlang, rust-lang, actix_identity"><title>actix_identity - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate actix_identity</p><div class="block version"><p>Version 0.3.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all actix_identity's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="actix_identity" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">actix_identity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#1-1142" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Request identity service for Actix applications.</p>
|
||||
<p><a href="struct.IdentityService.html"><strong>IdentityService</strong></a> middleware can be
|
||||
used with different policies types to store identity information.</p>
|
||||
<p>By default, only cookie identity policy is implemented. Other backend
|
||||
implementations can be added separately.</p>
|
||||
<p><a href="struct.CookieIdentityPolicy.html"><strong>CookieIdentityPolicy</strong></a>
|
||||
uses cookies as identity storage.</p>
|
||||
<p>To access current request identity
|
||||
<a href="struct.Identity.html"><strong>Identity</strong></a> extractor should be used.</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">actix_identity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#1-152" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Opinionated request identity service for Actix Web apps.</p>
|
||||
<p><a href="../actix_identity/struct.IdentityService.html" title="IdentityService"><code>IdentityService</code></a> middleware can be used with different policies types to store
|
||||
identity information.</p>
|
||||
<p>A cookie based policy is provided. <a href="../actix_identity/struct.CookieIdentityPolicy.html" title="CookieIdentityPolicy"><code>CookieIdentityPolicy</code></a> uses cookies as identity storage.</p>
|
||||
<p>To access current request identity, use the <a href="../actix_identity/struct.Identity.html" title="Identity"><code>Identity</code></a> extractor.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident">actix_identity</span>::{<span class="ident">Identity</span>, <span class="ident">CookieIdentityPolicy</span>, <span class="ident">IdentityService</span>};
|
||||
|
||||
<span class="attribute">#[<span class="ident">get</span>(<span class="string">"/"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="comment">// access request identity</span>
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">id</span>) <span class="op">=</span> <span class="ident">id</span>.<span class="ident">identity</span>() {
|
||||
@@ -24,32 +21,33 @@ uses cookies as identity storage.</p>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">post</span>(<span class="string">"/login"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">login</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">HttpResponse</span> {
|
||||
<span class="ident">id</span>.<span class="ident">remember</span>(<span class="string">"User1"</span>.<span class="ident">to_owned</span>()); <span class="comment">// <- remember identity</span>
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">finish</span>()
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">post</span>(<span class="string">"/logout"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">logout</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">HttpResponse</span> {
|
||||
<span class="ident">id</span>.<span class="ident">forget</span>(); <span class="comment">// <- remove identity</span>
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">finish</span>()
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(
|
||||
<span class="comment">// <- create identity middleware</span>
|
||||
<span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>]) <span class="comment">// <- create cookie identity policy</span>
|
||||
.<span class="ident">name</span>(<span class="string">"auth-cookie"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">false</span>)))
|
||||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/index.html"</span>).<span class="ident">to</span>(<span class="ident">index</span>))
|
||||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/login.html"</span>).<span class="ident">to</span>(<span class="ident">login</span>))
|
||||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/logout.html"</span>).<span class="ident">to</span>(<span class="ident">logout</span>));
|
||||
}</pre></div>
|
||||
<span class="comment">// create cookie identity backend</span>
|
||||
<span class="kw">let</span> <span class="ident">policy</span> <span class="op">=</span> <span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>])
|
||||
.<span class="ident">name</span>(<span class="string">"auth-cookie"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">false</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
||||
<span class="comment">// wrap policy into middleware identity middleware</span>
|
||||
.<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(<span class="ident">policy</span>))
|
||||
.<span class="ident">service</span>(<span class="macro">services</span><span class="macro">!</span>[<span class="ident">index</span>, <span class="ident">login</span>, <span class="ident">logout</span>]);</pre></div>
|
||||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||||
<table><tr class="module-item"><td><a class="struct" href="struct.CookieIdentityPolicy.html" title="actix_identity::CookieIdentityPolicy struct">CookieIdentityPolicy</a></td><td class="docblock-short"><p>Use cookies for request identity storage.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Identity.html" title="actix_identity::Identity struct">Identity</a></td><td class="docblock-short"><p>The extractor type to obtain your identity from a request.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.IdentityService.html" title="actix_identity::IdentityService struct">IdentityService</a></td><td class="docblock-short"><p>Request identity middleware</p>
|
||||
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.IdentityPolicy.html" title="actix_identity::IdentityPolicy trait">IdentityPolicy</a></td><td class="docblock-short"><p>Identity policy definition.</p>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.IdentityPolicy.html" title="actix_identity::IdentityPolicy trait">IdentityPolicy</a></td><td class="docblock-short"><p>Identity policy.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.RequestIdentity.html" title="actix_identity::RequestIdentity trait">RequestIdentity</a></td><td class="docblock-short"><p>Helper trait that allows to get Identity.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
10
actix_identity/middleware/struct.IdentityService.html
Normal file
10
actix_identity/middleware/struct.IdentityService.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../actix_identity/struct.IdentityService.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../actix_identity/struct.IdentityService.html">../../actix_identity/struct.IdentityService.html</a>...</p>
|
||||
<script>location.replace("../../actix_identity/struct.IdentityService.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1 +1 @@
|
||||
initSidebarItems({"struct":[["CookieIdentityPolicy","Use cookies for request identity storage."],["Identity","The extractor type to obtain your identity from a request."],["IdentityService","Request identity middleware"]],"trait":[["IdentityPolicy","Identity policy definition."],["RequestIdentity","Helper trait that allows to get Identity."]]});
|
||||
initSidebarItems({"struct":[["CookieIdentityPolicy","Use cookies for request identity storage."],["Identity","The extractor type to obtain your identity from a request."],["IdentityService","Request identity middleware"]],"trait":[["IdentityPolicy","Identity policy."],["RequestIdentity","Helper trait that allows to get Identity."]]});
|
||||
@@ -1,44 +1,53 @@
|
||||
<!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="Use cookies for request identity storage."><meta name="keywords" content="rust, rustlang, rust-lang, CookieIdentityPolicy"><title>actix_identity::CookieIdentityPolicy - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct CookieIdentityPolicy</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.domain">domain</a><a href="#method.http_only">http_only</a><a href="#method.login_deadline">login_deadline</a><a href="#method.max_age">max_age</a><a href="#method.max_age_time">max_age_time</a><a href="#method.name">name</a><a href="#method.new">new</a><a href="#method.path">path</a><a href="#method.same_site">same_site</a><a href="#method.secure">secure</a><a href="#method.visit_deadline">visit_deadline</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-IdentityPolicy">IdentityPolicy</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="CookieIdentityPolicy" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">CookieIdentityPolicy</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#474" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct CookieIdentityPolicy(_);</pre></div><div class="docblock"><p>Use cookies for request identity storage.</p>
|
||||
<p>The constructors take a key as an argument.
|
||||
This is the private key for cookie - when this value is changed,
|
||||
all identities are lost. The constructors will panic if the key is less
|
||||
than 32 bytes in length.</p>
|
||||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct CookieIdentityPolicy</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.domain">domain</a><a href="#method.http_only">http_only</a><a href="#method.login_deadline">login_deadline</a><a href="#method.max_age">max_age</a><a href="#method.max_age_secs">max_age_secs</a><a href="#method.name">name</a><a href="#method.new">new</a><a href="#method.path">path</a><a href="#method.same_site">same_site</a><a href="#method.secure">secure</a><a href="#method.visit_deadline">visit_deadline</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-IdentityPolicy">IdentityPolicy</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="CookieIdentityPolicy" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">CookieIdentityPolicy</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/cookie.rs.html#205" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct CookieIdentityPolicy(_);</pre></div><div class="docblock"><p>Use cookies for request identity storage.</p>
|
||||
<p><a href="mdn-cookies">See this page on MDN</a> for details on cookie attributes.</p>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">App</span>;
|
||||
<span class="kw">use</span> <span class="ident">actix_identity</span>::{<span class="ident">CookieIdentityPolicy</span>, <span class="ident">IdentityService</span>};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(
|
||||
<span class="comment">// <- create identity middleware</span>
|
||||
<span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>]) <span class="comment">// <- construct cookie policy</span>
|
||||
<span class="comment">// create cookie identity backend</span>
|
||||
<span class="kw">let</span> <span class="ident">policy</span> <span class="op">=</span> <span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>])
|
||||
.<span class="ident">domain</span>(<span class="string">"www.rust-lang.org"</span>)
|
||||
.<span class="ident">name</span>(<span class="string">"actix_auth"</span>)
|
||||
.<span class="ident">path</span>(<span class="string">"/"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">true</span>),
|
||||
));</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#476-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#480-482" title="goto source code">[src]</a></h4><div class="docblock"><p>Construct new <code>CookieIdentityPolicy</code> instance.</p>
|
||||
<p>Panics if key length is less than 32 bytes.</p>
|
||||
</div><h4 id="method.path" class="method"><code>pub fn <a href="#method.path" class="fnname">path</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#485-488" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>path</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.name" class="method"><code>pub fn <a href="#method.name" class="fnname">name</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#491-494" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>name</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.domain" class="method"><code>pub fn <a href="#method.domain" class="fnname">domain</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#497-500" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>domain</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.secure" class="method"><code>pub fn <a href="#method.secure" class="fnname">secure</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#506-509" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>secure</code> field in the session cookie being built.</p>
|
||||
<p>If the <code>secure</code> field is set, a cookie will only be transmitted when the
|
||||
connection is secure - i.e. <code>https</code></p>
|
||||
</div><h4 id="method.max_age" class="method"><code>pub fn <a href="#method.max_age" class="fnname">max_age</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#512-514" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built with given number of seconds.</p>
|
||||
</div><h4 id="method.max_age_time" class="method"><code>pub fn <a href="#method.max_age_time" class="fnname">max_age_time</a>(self, value: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#517-520" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built with <code>time::Duration</code>.</p>
|
||||
</div><h4 id="method.http_only" class="method"><code>pub fn <a href="#method.http_only" class="fnname">http_only</a>(self, http_only: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_identity/lib.rs.html#523-526" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>http_only</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.same_site" class="method"><code>pub fn <a href="#method.same_site" class="fnname">same_site</a>(self, same_site: <a class="enum" href="https://docs.rs/cookie/0.14/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>) -> Self</code><a class="srclink" href="../src/actix_identity/lib.rs.html#529-532" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>same_site</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.visit_deadline" class="method"><code>pub fn <a href="#method.visit_deadline" class="fnname">visit_deadline</a>(self, value: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#537-540" title="goto source code">[src]</a></h4><div class="docblock"><p>Accepts only users whose cookie has been seen before the given deadline</p>
|
||||
<p>By default visit deadline is disabled.</p>
|
||||
</div><h4 id="method.login_deadline" class="method"><code>pub fn <a href="#method.login_deadline" class="fnname">login_deadline</a>(self, value: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#545-548" title="goto source code">[src]</a></h4><div class="docblock"><p>Accepts only users which has been authenticated before the given deadline</p>
|
||||
<p>By default login deadline is disabled.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-IdentityPolicy" class="impl"><code class="in-band">impl <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-IdentityPolicy" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#551-610" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Future" class="type"><code>type <a href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" class="type">Future</a> = Ready<Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code></h4><div class='docblock'><p>The return type of the middleware</p>
|
||||
.<span class="ident">secure</span>(<span class="bool-val">true</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
||||
<span class="comment">// wrap policy into identity middleware</span>
|
||||
.<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(<span class="ident">policy</span>));</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/cookie.rs.html#207-298" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#215-217" title="goto source code">[src]</a></h4><div class="docblock"><p>Create new <code>CookieIdentityPolicy</code> instance.</p>
|
||||
<p>Key argument is the private key for issued cookies. If this value is changed, all issued
|
||||
cookie identities are invalidated.</p>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<p>Panics if <code>key</code> is less than 32 bytes in length..</p>
|
||||
</div><h4 id="method.name" class="method"><code>pub fn <a href="#method.name" class="fnname">name</a>(self, value: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#220-223" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the name of issued cookies.</p>
|
||||
</div><h4 id="method.path" class="method"><code>pub fn <a href="#method.path" class="fnname">path</a>(self, value: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#226-229" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>Path</code> attribute of issued cookies.</p>
|
||||
</div><h4 id="method.domain" class="method"><code>pub fn <a href="#method.domain" class="fnname">domain</a>(self, value: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#232-235" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>Domain</code> attribute of issued cookies.</p>
|
||||
</div><h4 id="method.secure" class="method"><code>pub fn <a href="#method.secure" class="fnname">secure</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#238-241" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>Secure</code> attribute of issued cookies.</p>
|
||||
</div><h4 id="method.max_age" class="method"><code>pub fn <a href="#method.max_age" class="fnname">max_age</a>(self, value: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#244-247" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>Max-Age</code> attribute of issued cookies.</p>
|
||||
</div><h4 id="method.max_age_secs" class="method"><code>pub fn <a href="#method.max_age_secs" class="fnname">max_age_secs</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#250-252" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>Max-Age</code> attribute of issued cookies with given number of seconds.</p>
|
||||
</div><h4 id="method.http_only" class="method"><code>pub fn <a href="#method.http_only" class="fnname">http_only</a>(self, http_only: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_identity/cookie.rs.html#257-260" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>HttpOnly</code> attribute of issued cookies.</p>
|
||||
<p>By default, the <code>HttpOnly</code> attribute is omitted from issued cookies.</p>
|
||||
</div><h4 id="method.same_site" class="method"><code>pub fn <a href="#method.same_site" class="fnname">same_site</a>(self, same_site: <a class="enum" href="https://docs.rs/cookie/0.14/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>) -> Self</code><a class="srclink" href="../src/actix_identity/cookie.rs.html#265-268" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>SameSite</code> attribute of issued cookies.</p>
|
||||
<p>By default, the <code>SameSite</code> attribute is omitted from issued cookies.</p>
|
||||
</div><h4 id="method.visit_deadline" class="method"><code>pub fn <a href="#method.visit_deadline" class="fnname">visit_deadline</a>(self, deadline: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#277-280" title="goto source code">[src]</a></h4><div class="docblock"><p>Accepts only users who have visited within given deadline.</p>
|
||||
<p>In other words, invalidate a login after some amount of inactivity. Using this feature
|
||||
causes updated cookies to be issued on each response in order to record the user’s last
|
||||
visitation timestamp.</p>
|
||||
<p>By default, visit deadline is disabled.</p>
|
||||
</div><h4 id="method.login_deadline" class="method"><code>pub fn <a href="#method.login_deadline" class="fnname">login_deadline</a>(self, deadline: Duration) -> <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#290-293" title="goto source code">[src]</a></h4><div class="docblock"><p>Accepts only users who authenticated within the given deadline.</p>
|
||||
<p>In other words, invalidate a login after some amount of time, regardless of activity.
|
||||
While <a href="../actix_identity/struct.CookieIdentityPolicy.html#method.max_age"><code>Max-Age</code></a> is useful in constraining the cookie
|
||||
lifetime, it could be extended manually; using this feature encodes the deadline directly
|
||||
into the issued cookies, making it immutable to users.</p>
|
||||
<p>By default, login deadline is disabled.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-IdentityPolicy" class="impl"><code class="in-band">impl <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-IdentityPolicy" class="anchor"></a><a class="srclink" href="../src/actix_identity/cookie.rs.html#300-364" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Future" class="type"><code>type <a href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" class="type">Future</a> = Ready<Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code></h4><div class='docblock'><p>The return type of the middleware</p>
|
||||
</div><h4 id="associatedtype.ResponseFuture" class="type"><code>type <a href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" class="type">ResponseFuture</a> = Ready<Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></code></h4><div class='docblock'><p>The return type of the middleware</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="../actix_identity/trait.IdentityPolicy.html#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#555-569" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Parse the session from request and load data from a service identity.</p>
|
||||
</div><h4 id="method.to_response" class="method hidden"><code>fn <a href="../actix_identity/trait.IdentityPolicy.html#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> res: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#571-609" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Write changes to response</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="../actix_identity/trait.IdentityPolicy.html#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#304-319" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Parse the session from request and load data from a service identity.</p>
|
||||
</div><h4 id="method.to_response" class="method hidden"><code>fn <a href="../actix_identity/trait.IdentityPolicy.html#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> res: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#321-363" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Write changes to response</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<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="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl !<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="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <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="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">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></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
|
||||
@@ -1,43 +1,50 @@
|
||||
<!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="The extractor type to obtain your identity from a request."><meta name="keywords" content="rust, rustlang, rust-lang, Identity"><title>actix_identity::Identity - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct Identity</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.forget">forget</a><a href="#method.identity">identity</a><a href="#method.remember">remember</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-FromRequest">FromRequest</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="Identity" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">Identity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#92" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Identity(_);</pre></div><div class="docblock"><p>The extractor type to obtain your identity from a request.</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">Identity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/identity.rs.html#45" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Identity(_);</pre></div><div class="docblock"><p>The extractor type to obtain your identity from a request.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident">actix_identity</span>::<span class="ident">Identity</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||||
<span class="attribute">#[<span class="ident">get</span>(<span class="string">"/"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
|
||||
<span class="comment">// access request identity</span>
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">id</span>) <span class="op">=</span> <span class="ident">id</span>.<span class="ident">identity</span>() {
|
||||
<span class="prelude-val">Ok</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Welcome! {}"</span>, <span class="ident">id</span>))
|
||||
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Welcome! {}"</span>, <span class="ident">id</span>)
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">Ok</span>(<span class="string">"Welcome Anonymous!"</span>.<span class="ident">to_owned</span>())
|
||||
<span class="string">"Welcome Anonymous!"</span>.<span class="ident">to_owned</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">login</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">HttpResponse</span> {
|
||||
<span class="ident">id</span>.<span class="ident">remember</span>(<span class="string">"User1"</span>.<span class="ident">to_owned</span>()); <span class="comment">// <- remember identity</span>
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">finish</span>()
|
||||
<span class="attribute">#[<span class="ident">post</span>(<span class="string">"/login"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">login</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
|
||||
<span class="comment">// remember identity</span>
|
||||
<span class="ident">id</span>.<span class="ident">remember</span>(<span class="string">"User1"</span>.<span class="ident">to_owned</span>());
|
||||
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">logout</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">HttpResponse</span> {
|
||||
<span class="ident">id</span>.<span class="ident">forget</span>(); <span class="comment">// <- remove identity</span>
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">finish</span>()
|
||||
<span class="attribute">#[<span class="ident">post</span>(<span class="string">"/logout"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">logout</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
|
||||
<span class="comment">// remove identity</span>
|
||||
<span class="ident">id</span>.<span class="ident">forget</span>();
|
||||
|
||||
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()
|
||||
}</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#94-125" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.identity" class="method"><code>pub fn <a href="#method.identity" class="fnname">identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#97-99" title="goto source code">[src]</a></h4><div class="docblock"><p>Return the claimed identity of the user associated request or
|
||||
<code>None</code> if no identity can be found associated with the request.</p>
|
||||
</div><h4 id="method.remember" class="method"><code>pub fn <a href="#method.remember" class="fnname">remember</a>(&self, identity: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class="srclink" href="../src/actix_identity/lib.rs.html#102-107" title="goto source code">[src]</a></h4><div class="docblock"><p>Remember identity.</p>
|
||||
</div><h4 id="method.forget" class="method"><code>pub fn <a href="#method.forget" class="fnname">forget</a>(&self)</code><a class="srclink" href="../src/actix_identity/lib.rs.html#111-116" title="goto source code">[src]</a></h4><div class="docblock"><p>This method is used to ‘forget’ the current identity on subsequent
|
||||
requests.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#91" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#91" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/identity.rs.html#47-74" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.identity" class="method"><code>pub fn <a href="#method.identity" class="fnname">identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/identity.rs.html#50-52" title="goto source code">[src]</a></h4><div class="docblock"><p>Return the claimed identity of the user associated request or <code>None</code> if no identity can be
|
||||
found associated with the request.</p>
|
||||
</div><h4 id="method.remember" class="method"><code>pub fn <a href="#method.remember" class="fnname">remember</a>(&self, identity: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class="srclink" href="../src/actix_identity/identity.rs.html#55-60" title="goto source code">[src]</a></h4><div class="docblock"><p>Remember identity.</p>
|
||||
</div><h4 id="method.forget" class="method"><code>pub fn <a href="#method.forget" class="fnname">forget</a>(&self)</code><a class="srclink" href="../src/actix_identity/identity.rs.html#63-68" title="goto source code">[src]</a></h4><div class="docblock"><p>This method is used to ‘forget’ the current identity on subsequent requests.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/actix_identity/identity.rs.html#44" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a class="srclink" href="../src/actix_identity/identity.rs.html#44" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-FromRequest" class="impl"><code class="in-band">impl FromRequest for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-FromRequest" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#165-174" title="goto source code">[src]</a></h3><div class="docblock"><p>Extractor implementation for Identity type.</p>
|
||||
</div></div><h3 id="impl-FromRequest" class="impl"><code class="in-band">impl FromRequest for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-FromRequest" class="anchor"></a><a class="srclink" href="../src/actix_identity/identity.rs.html#92-101" title="goto source code">[src]</a></h3><div class="docblock"><p>Extractor implementation for Identity type.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_identity</span>::<span class="ident">Identity</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="attribute">#[<span class="ident">get</span>(<span class="string">"/"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">id</span>: <span class="ident">Identity</span>) <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
|
||||
<span class="comment">// access request identity</span>
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">id</span>) <span class="op">=</span> <span class="ident">id</span>.<span class="ident">identity</span>() {
|
||||
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Welcome! {}"</span>, <span class="ident">id</span>)
|
||||
@@ -47,8 +54,8 @@ requests.</p>
|
||||
}</pre></div>
|
||||
</div><div class="impl-items"><h4 id="associatedtype.Config" class="type"><code>type <a href="#associatedtype.Config" class="type">Config</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><div class='docblock'><p>Configuration for this extractor.</p>
|
||||
</div><h4 id="associatedtype.Error" class="type"><code>type <a href="#associatedtype.Error" class="type">Error</a> = Error</code></h4><div class='docblock'><p>The associated error which can be returned.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<Result<<a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, Error>></code></h4><div class='docblock'><p>Future that resolves to a Self.</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</code><a class="srclink" href="../src/actix_identity/lib.rs.html#171-173" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, Error>></code></h4><div class='docblock'><p>Future that resolves to a Self.</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</code><a class="srclink" href="../src/actix_identity/identity.rs.html#98-100" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div><h4 id="method.extract" class="method hidden"><code>pub fn <a href="#method.extract" class="fnname">extract</a>(req: &HttpRequest) -> Self::Future</code></h4><div class='docblock hidden'><p>Create a Self from request head asynchronously. <a href="#method.extract">Read more</a></p>
|
||||
</div><h4 id="method.configure" class="method hidden"><code>pub fn <a href="#method.configure" class="fnname">configure</a><F>(f: F) -> Self::Config <span class="where fmt-newline">where<br> 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>(Self::Config) -> Self::Config, </span></code></h4><div class='docblock hidden'><p>Create and configure config instance.</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<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="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl !<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="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <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="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_identity/struct.Identity.html" title="struct actix_identity::Identity">Identity</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">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></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
|
||||
@@ -1,25 +1,27 @@
|
||||
<!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="Request identity middleware"><meta name="keywords" content="rust, rustlang, rust-lang, IdentityService"><title>actix_identity::IdentityService - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct IdentityService</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E">Transform<S, ServiceRequest></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="IdentityService" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">IdentityService</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#209-211" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct IdentityService<T> { /* fields omitted */ }</pre></div><div class="docblock"><p>Request identity middleware</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_identity</a>::<wbr><a class="struct" href="">IdentityService</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/middleware.rs.html#26-28" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct IdentityService<T> { /* fields omitted */ }</pre></div><div class="docblock"><p>Request identity middleware</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">App</span>;
|
||||
<span class="kw">use</span> <span class="ident">actix_identity</span>::{<span class="ident">CookieIdentityPolicy</span>, <span class="ident">IdentityService</span>};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(
|
||||
<span class="comment">// <- create identity middleware</span>
|
||||
<span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>]) <span class="comment">// <- create cookie session backend</span>
|
||||
.<span class="ident">name</span>(<span class="string">"auth-cookie"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">false</span>),
|
||||
));</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T> <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#213-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(backend: T) -> Self</code><a class="srclink" href="../src/actix_identity/lib.rs.html#215-219" title="goto source code">[src]</a></h4><div class="docblock"><p>Create new identity service with specified backend.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%2C%20ServiceRequest%3E" class="impl"><code class="in-band">impl<S, T, B> Transform<S, ServiceRequest> for <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T> <span class="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> T: <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a>,<br> B: 'static, </span></code><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#222-241" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Response" class="type"><code>type <a href="#associatedtype.Response" class="type">Response</a> = ServiceResponse<B></code></h4><div class='docblock'><p>Responses produced by the service.</p>
|
||||
<span class="comment">// create cookie identity backend</span>
|
||||
<span class="kw">let</span> <span class="ident">policy</span> <span class="op">=</span> <span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>])
|
||||
.<span class="ident">name</span>(<span class="string">"auth-cookie"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">false</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
||||
<span class="comment">// wrap policy into identity middleware</span>
|
||||
.<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(<span class="ident">policy</span>));</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T> <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_identity/middleware.rs.html#30-37" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(backend: T) -> Self</code><a class="srclink" href="../src/actix_identity/middleware.rs.html#32-36" title="goto source code">[src]</a></h4><div class="docblock"><p>Create new identity service with specified backend.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%2C%20ServiceRequest%3E" class="impl"><code class="in-band">impl<S, T, B> Transform<S, ServiceRequest> for <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T> <span class="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> T: <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a>,<br> B: 'static, </span></code><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E" class="anchor"></a><a class="srclink" href="../src/actix_identity/middleware.rs.html#39-58" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Response" class="type"><code>type <a href="#associatedtype.Response" class="type">Response</a> = ServiceResponse<B></code></h4><div class='docblock'><p>Responses produced by the service.</p>
|
||||
</div><h4 id="associatedtype.Error" class="type"><code>type <a href="#associatedtype.Error" class="type">Error</a> = Error</code></h4><div class='docblock'><p>Errors produced by the service.</p>
|
||||
</div><h4 id="associatedtype.InitError" class="type"><code>type <a href="#associatedtype.InitError" class="type">InitError</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><div class='docblock'><p>Errors produced while building a transform service.</p>
|
||||
</div><h4 id="associatedtype.Transform" class="type"><code>type <a href="#associatedtype.Transform" class="type">Transform</a> = IdentityServiceMiddleware<S, T></code></h4><div class='docblock'><p>The <code>TransformService</code> value created by this factory</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<Result<Self::Transform, Self::InitError>></code></h4><div class='docblock'><p>The future response value.</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_identity/lib.rs.html#235-240" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_identity/middleware.rs.html#52-57" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<T> !<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="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<T> !<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="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<T> <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="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_identity/struct.IdentityService.html" title="struct actix_identity::IdentityService">IdentityService</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">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></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">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 <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
<!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="Identity policy definition."><meta name="keywords" content="rust, rustlang, rust-lang, IdentityPolicy"><title>actix_identity::IdentityPolicy - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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="Identity policy."><meta name="keywords" content="rust, rustlang, rust-lang, IdentityPolicy"><title>actix_identity::IdentityPolicy - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait IdentityPolicy</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Future">Future</a><a href="#associatedtype.ResponseFuture">ResponseFuture</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_request">from_request</a><a href="#tymethod.to_response">to_response</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="IdentityPolicy" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="">IdentityPolicy</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#177-194" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait IdentityPolicy: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'static {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="">IdentityPolicy</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#65-82" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait IdentityPolicy: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'static {
|
||||
type <a href="#associatedtype.Future" class="type">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>>;
|
||||
type <a href="#associatedtype.ResponseFuture" class="type">ResponseFuture</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>>;
|
||||
fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, request: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a>;
|
||||
fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a>;
|
||||
<div class="item-spacer"></div> fn <a href="#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> identity: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> response: &mut ServiceResponse<B><br> ) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a>;
|
||||
}</pre></div><div class="docblock"><p>Identity policy definition.</p>
|
||||
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Future" class="method"><code>type <a href="#associatedtype.Future" class="type">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#179" title="goto source code">[src]</a></h3><div class="docblock"><p>The return type of the middleware</p>
|
||||
</div><h3 id="associatedtype.ResponseFuture" class="method"><code>type <a href="#associatedtype.ResponseFuture" class="type">ResponseFuture</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#182" title="goto source code">[src]</a></h3><div class="docblock"><p>The return type of the middleware</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.from_request" class="method"><code>fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, request: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#185" title="goto source code">[src]</a></h3><div class="docblock"><p>Parse the session from request and load data from a service identity.</p>
|
||||
</div><h3 id="tymethod.to_response" class="method"><code>fn <a href="#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> identity: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> response: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#188-193" title="goto source code">[src]</a></h3><div class="docblock"><p>Write changes to response</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-IdentityPolicy" class="impl"><code class="in-band">impl <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-IdentityPolicy" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#551-610" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Future-1" class="type"><code>type <a href="#associatedtype.Future-1" class="type">Future</a> = Ready<Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code></h4><h4 id="associatedtype.ResponseFuture-1" class="type"><code>type <a href="#associatedtype.ResponseFuture-1" class="type">ResponseFuture</a> = Ready<Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></code></h4><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#555-569" title="goto source code">[src]</a></h4><h4 id="method.to_response" class="method hidden"><code>fn <a href="#method.to_response" class="fnname">to_response</a><B>(<br> &self, <br> id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> res: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#571-609" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_identity/trait.IdentityPolicy.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-search-js="../search-index.js"></div>
|
||||
}</pre></div><div class="docblock"><p>Identity policy.</p>
|
||||
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Future" class="method"><code>type <a href="#associatedtype.Future" class="type">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#67" title="goto source code">[src]</a></h3><div class="docblock"><p>The return type of the middleware</p>
|
||||
</div><h3 id="associatedtype.ResponseFuture" class="method"><code>type <a href="#associatedtype.ResponseFuture" class="type">ResponseFuture</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#70" title="goto source code">[src]</a></h3><div class="docblock"><p>The return type of the middleware</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.from_request" class="method"><code>fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#73" title="goto source code">[src]</a></h3><div class="docblock"><p>Parse the session from request and load data from a service identity.</p>
|
||||
</div><h3 id="tymethod.to_response" class="method"><code>fn <a href="#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> identity: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> response: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/lib.rs.html#76-81" title="goto source code">[src]</a></h3><div class="docblock"><p>Write changes to response</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-IdentityPolicy" class="impl"><code class="in-band">impl <a class="trait" href="../actix_identity/trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a> for <a class="struct" href="../actix_identity/struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></code><a href="#impl-IdentityPolicy" class="anchor"></a><a class="srclink" href="../src/actix_identity/cookie.rs.html#300-364" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Future-1" class="type"><code>type <a href="#associatedtype.Future-1" class="type">Future</a> = Ready<Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></code></h4><h4 id="associatedtype.ResponseFuture-1" class="type"><code>type <a href="#associatedtype.ResponseFuture-1" class="type">ResponseFuture</a> = Ready<Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></code></h4><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#304-319" title="goto source code">[src]</a></h4><h4 id="method.to_response" class="method hidden"><code>fn <a href="#method.to_response" class="fnname">to_response</a><B>(<br> &self, <br> id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> res: &mut ServiceResponse<B><br>) -> Self::<a class="type" href="../actix_identity/trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></code><a class="srclink" href="../src/actix_identity/cookie.rs.html#321-363" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_identity/trait.IdentityPolicy.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
@@ -1,10 +1,10 @@
|
||||
<!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="Helper trait that allows to get Identity."><meta name="keywords" content="rust, rustlang, rust-lang, RequestIdentity"><title>actix_identity::RequestIdentity - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait RequestIdentity</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_identity">get_identity</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">actix_identity</a></p><div id="sidebar-vars" data-name="RequestIdentity" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="">RequestIdentity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#136-138" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait RequestIdentity {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="">RequestIdentity</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/actix_identity/lib.rs.html#88-90" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait RequestIdentity {
|
||||
fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>;
|
||||
}</pre></div><div class="docblock"><p>Helper trait that allows to get Identity.</p>
|
||||
<p>It could be used in middleware but identity policy must be set before any other middleware that needs identity
|
||||
RequestIdentity is implemented both for <code>ServiceRequest</code> and <code>HttpRequest</code>.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.get_identity" class="method"><code>fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#137" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-RequestIdentity" class="impl"><code class="in-band">impl<T> <a class="trait" href="../actix_identity/trait.RequestIdentity.html" title="trait actix_identity::RequestIdentity">RequestIdentity</a> for T <span class="where fmt-newline">where<br> T: HttpMessage, </span></code><a href="#impl-RequestIdentity" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#140-147" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_identity" class="method hidden"><code>fn <a href="#method.get_identity" class="fnname">get_identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#144-146" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_identity/trait.RequestIdentity.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-search-js="../search-index.js"></div>
|
||||
<p>It could be used in middleware but identity policy must be set before any other middleware that
|
||||
needs identity. RequestIdentity is implemented both for <code>ServiceRequest</code> and <code>HttpRequest</code>.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.get_identity" class="method"><code>fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#89" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-RequestIdentity" class="impl"><code class="in-band">impl<T> <a class="trait" href="../actix_identity/trait.RequestIdentity.html" title="trait actix_identity::RequestIdentity">RequestIdentity</a> for T <span class="where fmt-newline">where<br> T: HttpMessage, </span></code><a href="#impl-RequestIdentity" class="anchor"></a><a class="srclink" href="../src/actix_identity/lib.rs.html#92-99" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_identity" class="method hidden"><code>fn <a href="#method.get_identity" class="fnname">get_identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_identity/lib.rs.html#96-98" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_identity/trait.RequestIdentity.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
Reference in New Issue
Block a user