mirror of
https://github.com/actix/actix-extras.git
synced 2025-03-28 23:18:40 +01:00
134 lines
10 KiB
HTML
134 lines
10 KiB
HTML
<!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="icon" href="https://actix.rs/favicon.ico"></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_settings/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../actix_settings/index.html"><div class="logo-container">
|
||
<img src="https://actix.rs/img/logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../actix_settings/index.html">
|
||
<img src="https://actix.rs/img/logo.png" 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>
|
||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">address</span>;
|
||
<span class="kw">mod</span> <span class="ident">backlog</span>;
|
||
<span class="kw">mod</span> <span class="ident">keep_alive</span>;
|
||
<span class="kw">mod</span> <span class="ident">max_connection_rate</span>;
|
||
<span class="kw">mod</span> <span class="ident">max_connections</span>;
|
||
<span class="kw">mod</span> <span class="ident">mode</span>;
|
||
<span class="kw">mod</span> <span class="ident">num_workers</span>;
|
||
<span class="kw">mod</span> <span class="ident">timeout</span>;
|
||
<span class="kw">mod</span> <span class="ident">tls</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::address::Address</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::backlog::Backlog</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::keep_alive::KeepAlive</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::max_connection_rate::MaxConnectionRate</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::max_connections::MaxConnections</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::mode::Mode</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::num_workers::NumWorkers</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::timeout::Timeout</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::tls::Tls</span>;
|
||
|
||
<span class="doccomment">/// Settings types for Actix Web.</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">rename_all</span> <span class="op">=</span> <span class="string">"kebab-case"</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ActixSettings</span> {
|
||
<span class="doccomment">/// List of addresses for the server to bind to.</span>
|
||
<span class="kw">pub</span> <span class="ident">hosts</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Address</span><span class="op">></span>,
|
||
|
||
<span class="doccomment">/// Marker of intended deployment environment.</span>
|
||
<span class="kw">pub</span> <span class="ident">mode</span>: <span class="ident">Mode</span>,
|
||
|
||
<span class="doccomment">/// True if the [`Compress`](actix_web::middleware::Compress) middleware should be enabled.</span>
|
||
<span class="kw">pub</span> <span class="ident">enable_compression</span>: <span class="ident">bool</span>,
|
||
|
||
<span class="doccomment">/// True if the [`Logger`](actix_web::middleware::Logger) middleware should be enabled.</span>
|
||
<span class="kw">pub</span> <span class="ident">enable_log</span>: <span class="ident">bool</span>,
|
||
|
||
<span class="doccomment">/// The number of workers that the server should start.</span>
|
||
<span class="kw">pub</span> <span class="ident">num_workers</span>: <span class="ident">NumWorkers</span>,
|
||
|
||
<span class="doccomment">/// The maximum number of pending connections.</span>
|
||
<span class="kw">pub</span> <span class="ident">backlog</span>: <span class="ident">Backlog</span>,
|
||
|
||
<span class="doccomment">/// The per-worker maximum number of concurrent connections.</span>
|
||
<span class="kw">pub</span> <span class="ident">max_connections</span>: <span class="ident">MaxConnections</span>,
|
||
|
||
<span class="doccomment">/// The per-worker maximum concurrent TLS connection limit.</span>
|
||
<span class="kw">pub</span> <span class="ident">max_connection_rate</span>: <span class="ident">MaxConnectionRate</span>,
|
||
|
||
<span class="doccomment">/// Server keep-alive preference.</span>
|
||
<span class="kw">pub</span> <span class="ident">keep_alive</span>: <span class="ident">KeepAlive</span>,
|
||
|
||
<span class="doccomment">/// Timeout duration for reading client request header.</span>
|
||
<span class="kw">pub</span> <span class="ident">client_timeout</span>: <span class="ident">Timeout</span>,
|
||
|
||
<span class="doccomment">/// Timeout duration for connection shutdown.</span>
|
||
<span class="kw">pub</span> <span class="ident">client_shutdown</span>: <span class="ident">Timeout</span>,
|
||
|
||
<span class="doccomment">/// Timeout duration for graceful worker shutdown.</span>
|
||
<span class="kw">pub</span> <span class="ident">shutdown_timeout</span>: <span class="ident">Timeout</span>,
|
||
|
||
<span class="doccomment">/// TLS (HTTPS) configuration.</span>
|
||
<span class="kw">pub</span> <span class="ident">tls</span>: <span class="ident">Tls</span>,
|
||
}
|
||
</code></pre></div>
|
||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_settings" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (0f4bcadb4 2022-07-30)" ></div></body></html> |