mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 21:16:37 +02:00
123 lines
8.0 KiB
HTML
123 lines
8.0 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`."><title>mod.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>
|
||
</pre></div><pre class="rust"><code><span class="kw">use </span>serde::Deserialize;
|
||
|
||
<span class="kw">mod </span>address;
|
||
<span class="kw">mod </span>backlog;
|
||
<span class="kw">mod </span>keep_alive;
|
||
<span class="kw">mod </span>max_connection_rate;
|
||
<span class="kw">mod </span>max_connections;
|
||
<span class="kw">mod </span>mode;
|
||
<span class="kw">mod </span>num_workers;
|
||
<span class="kw">mod </span>timeout;
|
||
<span class="kw">mod </span>tls;
|
||
|
||
<span class="kw">pub use </span><span class="self">self</span>::{
|
||
address::Address, backlog::Backlog, keep_alive::KeepAlive,
|
||
max_connection_rate::MaxConnectionRate, max_connections::MaxConnections, mode::Mode,
|
||
num_workers::NumWorkers, timeout::Timeout, tls::Tls,
|
||
};
|
||
|
||
<span class="doccomment">/// Settings types for Actix Web.
|
||
</span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize)]
|
||
#[serde(rename_all = <span class="string">"kebab-case"</span>)]
|
||
</span><span class="kw">pub struct </span>ActixSettings {
|
||
<span class="doccomment">/// List of addresses for the server to bind to.
|
||
</span><span class="kw">pub </span>hosts: Vec<Address>,
|
||
|
||
<span class="doccomment">/// Marker of intended deployment environment.
|
||
</span><span class="kw">pub </span>mode: Mode,
|
||
|
||
<span class="doccomment">/// True if the [`Compress`](actix_web::middleware::Compress) middleware should be enabled.
|
||
</span><span class="kw">pub </span>enable_compression: bool,
|
||
|
||
<span class="doccomment">/// True if the [`Logger`](actix_web::middleware::Logger) middleware should be enabled.
|
||
</span><span class="kw">pub </span>enable_log: bool,
|
||
|
||
<span class="doccomment">/// The number of workers that the server should start.
|
||
</span><span class="kw">pub </span>num_workers: NumWorkers,
|
||
|
||
<span class="doccomment">/// The maximum number of pending connections.
|
||
</span><span class="kw">pub </span>backlog: Backlog,
|
||
|
||
<span class="doccomment">/// The per-worker maximum number of concurrent connections.
|
||
</span><span class="kw">pub </span>max_connections: MaxConnections,
|
||
|
||
<span class="doccomment">/// The per-worker maximum concurrent TLS connection limit.
|
||
</span><span class="kw">pub </span>max_connection_rate: MaxConnectionRate,
|
||
|
||
<span class="doccomment">/// Server keep-alive preference.
|
||
</span><span class="kw">pub </span>keep_alive: KeepAlive,
|
||
|
||
<span class="doccomment">/// Timeout duration for reading client request header.
|
||
</span><span class="kw">pub </span>client_timeout: Timeout,
|
||
|
||
<span class="doccomment">/// Timeout duration for connection shutdown.
|
||
</span><span class="kw">pub </span>client_shutdown: Timeout,
|
||
|
||
<span class="doccomment">/// Timeout duration for graceful worker shutdown.
|
||
</span><span class="kw">pub </span>shutdown_timeout: Timeout,
|
||
|
||
<span class="doccomment">/// TLS (HTTPS) configuration.
|
||
</span><span class="kw">pub </span>tls: Tls,
|
||
}
|
||
</code></pre></div></section></main></body></html> |