<!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="Source of the Rust file `actix-identity/src/config.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>config.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_identity/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
</pre><pre class="rust"><code><span class="doccomment">//! Configuration options to tune the behaviour of [`IdentityMiddleware`].</span>
<span class="kw">use</span> <span class="ident">std::time::Duration</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::IdentityMiddleware</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Configuration</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">on_logout</span>: <span class="ident">LogoutBehaviour</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">login_deadline</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">visit_deadline</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Configuration</span> {
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
<span class="self">Self</span> {
<span class="ident">on_logout</span>: <span class="ident">LogoutBehaviour::PurgeSession</span>,
<span class="ident">login_deadline</span>: <span class="prelude-val">None</span>,
<span class="ident">visit_deadline</span>: <span class="prelude-val">None</span>,
}
}
}
<span class="doccomment">/// `LogoutBehaviour` controls what actions are going to be performed when [`Identity::logout`] is</span>
<span class="doccomment">/// invoked.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Identity::logout`]: crate::Identity::logout</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="attribute">#[<span class="ident">non_exhaustive</span>]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">LogoutBehaviour</span> {
<span class="doccomment">/// When [`Identity::logout`](crate::Identity::logout) is called, purge the current session.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This behaviour might be desirable when you have stored additional information in the</span>
<span class="doccomment">/// session state that are tied to the user's identity and should not be retained after logout.</span>
<span class="ident">PurgeSession</span>,
<span class="doccomment">/// When [`Identity::logout`](crate::Identity::logout) is called, remove the identity</span>
<span class="doccomment">/// information from the current session state. The session itself is not destroyed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This behaviour might be desirable when you have stored information in the session state that</span>
<span class="doccomment">/// is not tied to the user's identity and should be retained after logout.</span>
<span class="ident">DeleteIdentityKeys</span>,
}
<span class="doccomment">/// A fluent builder to construct an [`IdentityMiddleware`] instance with custom configuration</span>
<span class="doccomment">/// parameters.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use [`IdentityMiddleware::builder`] to get started!</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">IdentityMiddlewareBuilder</span> {
<span class="ident">configuration</span>: <span class="ident">Configuration</span>,
}
<span class="kw">impl</span> <span class="ident">IdentityMiddlewareBuilder</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
<span class="self">Self</span> {
<span class="ident">configuration</span>: <span class="ident">Configuration::default</span>(),
}
}
<span class="doccomment">/// Determines how [`Identity::logout`](crate::Identity::logout) affects the current session.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By default, the current session is purged ([`LogoutBehaviour::PurgeSession`]).</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">logout_behaviour</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">logout_behaviour</span>: <span class="ident">LogoutBehaviour</span>) -> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">on_logout</span> <span class="op">=</span> <span class="ident">logout_behaviour</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Automatically logs out users after a certain amount of time has passed since they logged in,</span>
<span class="doccomment">/// regardless of their activity pattern.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If set to:</span>
<span class="doccomment">/// - `None`: login deadline is disabled.</span>
<span class="doccomment">/// - `Some(duration)`: login deadline is enabled and users will be logged out after `duration`</span>
<span class="doccomment">/// has passed since their login.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By default, login deadline is disabled.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">login_deadline</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">deadline</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>) -> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">login_deadline</span> <span class="op">=</span> <span class="ident">deadline</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Automatically logs out users after a certain amount of time has passed since their last</span>
<span class="doccomment">/// visit.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If set to:</span>
<span class="doccomment">/// - `None`: visit deadline is disabled.</span>
<span class="doccomment">/// - `Some(duration)`: visit deadline is enabled and users will be logged out after `duration`</span>
<span class="doccomment">/// has passed since their last visit.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By default, visit deadline is disabled.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">visit_deadline</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">deadline</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>) -> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">visit_deadline</span> <span class="op">=</span> <span class="ident">deadline</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Finalises the builder and returns an [`IdentityMiddleware`] instance.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) -> <span class="ident">IdentityMiddleware</span> {
<span class="ident">IdentityMiddleware::new</span>(<span class="self">self</span>.<span class="ident">configuration</span>)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_identity" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (0f4bcadb4 2022-07-30)" ></div></body></html>