<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Configuration for which events should trigger an extension of the time-to-live for your session."><metaname="keywords"content="rust, rustlang, rust-lang, TtlExtensionPolicy"><title>TtlExtensionPolicy in actix_session::config - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-04897efae0a76fcd.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../../static.files/light-4743e13df3dfe8c4.css"><linkrel="stylesheet"disabledhref="../../static.files/dark-0e1b889528bd466b.css"><linkrel="stylesheet"disabledhref="../../static.files/ayu-65289d5d067c7c66.css"><scriptid="default-settings"></script><scriptsrc="../../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-bc1b32400f872ddb.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-13285aec31fa243e.css"></noscript><linkrel="icon"href="https://actix.rs/favicon.ico"></head><bodyclass="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../../actix_session/index.html"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../../actix_session/index.html">
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><h2class="location"><ahref="#">TtlExtensionPolicy</a></h2><divclass="sidebar-elems"><section><h3><ahref="#variants">Variants</a></h3><ulclass="block"><li><ahref="#variant.OnEveryRequest">OnEveryRequest</a></li><li><ahref="#variant.OnStateChanges">OnStateChanges</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-Clone-for-TtlExtensionPolicy">Clone</a></li><li><ahref="#impl-Debug-for-TtlExtensionPolicy">Debug</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-TtlExtensionPolicy">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-TtlExtensionPolicy">Send</a></li><li><ahref="#impl-Sync-for-TtlExtensionPolicy">Sync</a></li><li><ahref="#impl-Unpin-for-TtlExtensionPolicy">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-TtlExtensionPolicy">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-TtlExtensionPolicy">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-TtlExtensionPolicy">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-TtlExtensionPolicy">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-TtlExtensionPolicy">From<T></a></li><li><ahref="#impl-Instrument-for-TtlExtensionPolicy">Instrument</a></li><li><ahref="#impl-Into%3CU%3E-for-TtlExtensionPolicy">Into<U></a></li><li><ahref="#impl-Same%3CT%3E-for-TtlExtensionPolicy">Same<T></a></li><li><ahref="#impl-ToOwned-for-TtlExtensionPolicy">ToOwned</a></li><li><ahref="#impl-TryFrom%3CU%3E-for-TtlExtensionPolicy">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-TtlExtensionPolicy">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E-for-TtlExtensionPolicy">VZip<V></a></li><li><ahref="#impl-WithSubscriber-for-TtlExtensionPolicy">WithSubscriber</a></li></ul></section><h2><ahref="index.html">In actix_session::config</a></h2></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1class="fqn">Enum <ahref="../index.html">actix_session</a>::<wbr><ahref="index.html">config</a>::<wbr><aclass="enum"href="#">TtlExtensionPolicy</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="srclink"href="../../src/actix_session/config.rs.html#171-184">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><divclass="item-decl"><preclass="rust enum"><code>#[non_exhaustive]
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Configuration for which events should trigger an extension of the time-to-live for your session.</p>
<p>If you are using a <ahref="struct.BrowserSession.html"title="BrowserSession"><code>BrowserSession</code></a>, <code>TtlExtensionPolicy</code> controls how often the TTL of the
session state should be refreshed. The browser is in control of the lifecycle of the session
cookie.</p>
<p>If you are using a <ahref="struct.PersistentSession.html"title="PersistentSession"><code>PersistentSession</code></a>, <code>TtlExtensionPolicy</code> controls both the expiration of
the session cookie and the TTL of the session state on the storage backend.</p>
</div></details><h2id="variants"class="variants small-section-header">Variants (Non-exhaustive)<ahref="#variants"class="anchor">§</a></h2><detailsclass="rustdoc-toggle non-exhaustive"><summaryclass="hideme"><span>This enum is marked as non-exhaustive</span></summary><divclass="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><divclass="variants"><sectionid="variant.OnEveryRequest"class="variant"><ahref="#variant.OnEveryRequest"class="anchor">§</a><h3class="code-header">OnEveryRequest</h3></section><divclass="docblock"><p>The TTL is refreshed every time the server receives a request associated with a session.</p>
</div><sectionid="variant.OnStateChanges"class="variant"><ahref="#variant.OnStateChanges"class="anchor">§</a><h3class="code-header">OnStateChanges</h3></section><divclass="docblock"><p>The TTL is refreshed every time the session state changes or the session key is renewed.</p>
</div></div><h2id="trait-implementations"class="small-section-header">Trait Implementations<ahref="#trait-implementations"class="anchor">§</a></h2><divid="trait-implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Clone-for-TtlExtensionPolicy"class="impl has-srclink"><aclass="srclink rightside"href="../../src/actix_session/config.rs.html#169">source</a><ahref="#impl-Clone-for-TtlExtensionPolicy"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="enum"href="enum.TtlExtensionPolicy.html"title="enum actix_session::config::TtlExtensionPolicy">TtlExtensionPolicy</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clone"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../../src/actix_session/config.rs.html#169">source</a><ahref="#method.clone"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone"class="fn">clone</a>(&self) -><aclass="enum"href="enum.TtlExtensionPolicy.html"title="enum actix_session::config::TtlExtensionPolicy">TtlExtensionPolicy</a></h4></section></summary><divclass='docblock'>Returns a copy of the value. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clone_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="Stable since Rust version 1.0.0">1.0.0</span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#132-134">source</a></span><ahref="#method.clone_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from"class="fn">clone_from</a>(&mut self, source: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><divclass='docblock'>Performs copy-assignment from <code>source</code>. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Debug-for-TtlExtensionPolicy"class="impl has-srclink"><aclass="srclink rightside"href="../../src/actix_session/config.rs.html#169">source</a><ahref="#impl-Debug-for-TtlExtensionPolicy"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="enum"href="enum.TtlExtensionPolicy.html"title="enum actix_session::config::TtlExtensionPolicy">TtlExtensionPolicy</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.fmt"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../../src/actix_session/config.rs.html#169">source</a><ahref="#method.fmt"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt"class="fn">fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a><'_>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></h4></section></summary><divclass='docblock'>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synt
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-TtlExtensionPolicy"class="impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-TtlExtensionPolicy"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument"class="fn">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fn">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="WithDispatch"><code>WithDispatch</code></a> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fn">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
