<!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="API documentation for the Rust `actix_web_sql_identity` crate."><meta name="keywords" content="rust, rustlang, rust-lang, actix_web_sql_identity"><title>actix_web_sql_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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></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">☰</div><p class='location'>Crate actix_web_sql_identity</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'actix_web_sql_identity', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="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_web_sql_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_web_sql_identity/lib.rs.html#1-491' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>A database (SQL) Identity Provider</p>
<p>Provides a way to interact with SQL databases with actix-web's
identity policy.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix_web</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix_web_sql_identity</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">server</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">Responder</span>};
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">middleware</span>::<span class="ident">identity</span>::{<span class="ident">IdentityService</span>, <span class="ident">RequestIdentity</span>};
<span class="kw">use</span> <span class="ident">actix_web_sql_identity</span>::<span class="ident">SqlIdentityBuilder</span>;
<span class="kw">const</span> <span class="ident">POOL_SIZE</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">3</span>; <span class="comment">// Number of connections per pool</span>
<span class="kw">fn</span> <span class="ident">login</span>(<span class="kw-2">mut</span> <span class="ident">req</span>: <span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="comment">// Should pull username/id from request</span>
<span class="ident">req</span>.<span class="ident">remember</span>(<span class="string">"username_or_id"</span>.<span class="ident">to_string</span>());
<span class="string">"Logged in!"</span>.<span class="ident">to_string</span>()
}
<span class="kw">fn</span> <span class="ident">profile</span>(<span class="ident">req</span>: <span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">user</span>) <span class="op">=</span> <span class="ident">req</span>.<span class="ident">identity</span>() {
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Hello, {}!"</span>, <span class="ident">user</span>)
} <span class="kw">else</span> {
<span class="string">"Hello, anonymous user!"</span>.<span class="ident">to_string</span>()
}
}
<span class="kw">fn</span> <span class="ident">logout</span>(<span class="kw-2">mut</span> <span class="ident">req</span>: <span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="ident">req</span>.<span class="ident">forget</span>();
<span class="string">"Logged out!"</span>.<span class="ident">to_string</span>()
}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="ident">server</span>::<span class="ident">new</span>(<span class="op">||</span> {
<span class="kw">let</span> <span class="ident">policy</span> <span class="op">=</span> <span class="ident">SqlIdentityBuilder</span>::<span class="ident">new</span>(<span class="string">"sqlite://my.db"</span>)
.<span class="ident">pool_size</span>(<span class="ident">POOL_SIZE</span>);
<span class="ident">App</span>::<span class="ident">new</span>()
.<span class="ident">route</span>(<span class="string">"/login"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">POST</span>, <span class="ident">login</span>)
.<span class="ident">route</span>(<span class="string">"/profile"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">GET</span>, <span class="ident">profile</span>)
.<span class="ident">route</span>(<span class="string">"/logout"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">POST</span>, <span class="ident">logout</span>)
.<span class="ident">middleware</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(
<span class="ident">policy</span>.<span class="ident">finish</span>()
.<span class="ident">expect</span>(<span class="string">"failed to connect to database"</span>)))
})
.<span class="ident">bind</span>(<span class="string">"127.0.0.1:7070"</span>).<span class="ident">unwrap</span>()
.<span class="ident">run</span>();
}</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.SqlIdentity.html"
title='struct actix_web_sql_identity::SqlIdentity'>SqlIdentity</a></td>
<td class='docblock-short'>
<p>Identity that uses a SQL database as identity storage</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SqlIdentityBuilder.html"
title='struct actix_web_sql_identity::SqlIdentityBuilder'>SqlIdentityBuilder</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SqlIdentityPolicy.html"
title='struct actix_web_sql_identity::SqlIdentityPolicy'>SqlIdentityPolicy</a></td>
<td class='docblock-short'>
<p>Use a SQL database for request identity storage</p>
</td>
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "actix_web_sql_identity";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>