<!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-settings/src/settings/keep_alive.rs`."><title>keep_alive.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ae1b282cda4c21ec.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_settings" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0-nightly (ca2b74f1a 2023-09-14)" data-channel="nightly" data-search-js="search-5d3eaacf19ebf04f.js" data-settings-js="settings-74424d7eec62a23e.js" data-theme-light-css="light-f194925aa375ae96.css" data-theme-dark-css="dark-1dd4d1ce031e15de.css" data-theme-ayu-css="ayu-49e58d069f567085.css" ><script src="../../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-cabe4b1bd7b9da95.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../../static.files/light-f194925aa375ae96.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../../static.files/dark-1dd4d1ce031e15de.css"><link rel="stylesheet" href="../../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../../actix_settings/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>once_cell::sync::Lazy;
<span class="kw">use </span>regex::Regex;
<span class="kw">use </span>serde::de;
<span class="kw">use crate</span>::{AsResult, Error, Parse};
<span class="doccomment">/// The server keep-alive preference.
///
/// By default keep alive is set to 5 seconds. Takes a string value: Either "default", "disabled",
/// "os", or a string of the format "N seconds" where N is an integer > 0 e.g. "6 seconds".
</span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, Hash)]
</span><span class="kw">pub enum </span>KeepAlive {
<span class="doccomment">/// The default keep-alive as defined by Actix Web.
</span>Default,
<span class="doccomment">/// Disable keep-alive.
</span>Disabled,
<span class="doccomment">/// Let the OS determine keep-alive duration.
///
/// Note: this is usually quite long.
</span>Os,
<span class="doccomment">/// A specific keep-alive duration (in seconds).
</span>Seconds(usize),
}
<span class="kw">impl </span>Parse <span class="kw">for </span>KeepAlive {
<span class="kw">fn </span>parse(string: <span class="kw-2">&</span>str) -> AsResult<<span class="self">Self</span>> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>FMT: Lazy<Regex> =
Lazy::new(|| Regex::new(<span class="string">r"^\d+ seconds$"</span>).expect(<span class="string">"Failed to compile regex: FMT"</span>));
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DIGITS: Lazy<Regex> =
Lazy::new(|| Regex::new(<span class="string">r"^\d+"</span>).expect(<span class="string">"Failed to compile regex: FMT"</span>));
<span class="macro">macro_rules! </span>invalid_value {
(<span class="macro-nonterminal">$got</span>:expr) => {
<span class="prelude-val">Err</span>(<span class="macro">InvalidValue! </span>{
expected: <span class="string">"a string of the format \"N seconds\" where N is an integer > 0"</span>,
got: <span class="macro-nonterminal">$got</span>,
})
};
}
<span class="kw">let </span>digits_in = |m: regex::Match<<span class="lifetime">'_</span>>| <span class="kw-2">&</span>string[m.start()..m.end()];
<span class="kw">match </span>string {
<span class="string">"default" </span>=> <span class="prelude-val">Ok</span>(KeepAlive::Default),
<span class="string">"disabled" </span>=> <span class="prelude-val">Ok</span>(KeepAlive::Disabled),
<span class="string">"OS" </span>| <span class="string">"os" </span>=> <span class="prelude-val">Ok</span>(KeepAlive::Os),
string <span class="kw">if </span>!FMT.is_match(string) => <span class="macro">invalid_value!</span>(string),
string => <span class="kw">match </span>DIGITS.find(string) {
<span class="prelude-val">None </span>=> <span class="macro">invalid_value!</span>(string),
<span class="prelude-val">Some</span>(mat) => <span class="kw">match </span>digits_in(mat).parse() {
<span class="prelude-val">Ok</span>(val) => <span class="prelude-val">Ok</span>(KeepAlive::Seconds(val)),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">invalid_value!</span>(string),
},
},
}
}
}
<span class="kw">impl</span><<span class="lifetime">'de</span>> de::Deserialize<<span class="lifetime">'de</span>> <span class="kw">for </span>KeepAlive {
<span class="kw">fn </span>deserialize<D>(deserializer: D) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, D::Error>
<span class="kw">where
</span>D: de::Deserializer<<span class="lifetime">'de</span>>,
{
<span class="kw">struct </span>KeepAliveVisitor;
<span class="kw">impl</span><<span class="lifetime">'de</span>> de::Visitor<<span class="lifetime">'de</span>> <span class="kw">for </span>KeepAliveVisitor {
<span class="kw">type </span>Value = KeepAlive;
<span class="kw">fn </span>expecting(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
<span class="kw">let </span>msg = <span class="string">"Either \"default\", \"disabled\", \"os\", or a string of the format \"N seconds\" where N is an integer > 0"</span>;
f.write_str(msg)
}
<span class="kw">fn </span>visit_str<E>(<span class="self">self</span>, value: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>::Value, E>
<span class="kw">where
</span>E: de::Error,
{
<span class="kw">match </span>KeepAlive::parse(value) {
<span class="prelude-val">Ok</span>(keep_alive) => <span class="prelude-val">Ok</span>(keep_alive),
<span class="prelude-val">Err</span>(Error::InvalidValue { expected, got, .. }) => <span class="prelude-val">Err</span>(
de::Error::invalid_value(de::Unexpected::Str(<span class="kw-2">&</span>got), <span class="kw-2">&</span>expected),
),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">unreachable!</span>(),
}
}
}
deserializer.deserialize_string(KeepAliveVisitor)
}
}
</code></pre></div></section></main></body></html>