<!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="Wrapper for server and application-specific settings."><metaname="keywords"content="rust, rustlang, rust-lang, BasicSettings"><title>BasicSettings in actix_settings - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"href="../normalize.css"><linkrel="stylesheet"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"href="../ayu.css"disabled><linkrel="stylesheet"href="../dark.css"disabled><linkrel="stylesheet"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../main.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="icon"href="https://actix.rs/favicon.ico"></head><bodyclass="rustdoc struct"><!--[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="sidebar-logo"href="../actix_settings/index.html"><divclass="logo-container"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></div></a><h2></h2></nav><navclass="sidebar"><aclass="sidebar-logo"href="../actix_settings/index.html"><divclass="logo-container">
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></div></a><h2class="location"><ahref="#">BasicSettings</a></h2><divclass="sidebar-elems"><section><h3><ahref="#fields">Fields</a></h3><ulclass="block"><li><ahref="#structfield.actix">actix</a></li><li><ahref="#structfield.application">application</a></li></ul><h3><ahref="#implementations">Methods</a></h3><ulclass="block"><li><ahref="#method.from_default_template">from_default_template</a></li><li><ahref="#method.from_template">from_template</a></li><li><ahref="#method.override_field">override_field</a></li><li><ahref="#method.override_field_with_env_var">override_field_with_env_var</a></li><li><ahref="#method.parse_toml">parse_toml</a></li><li><ahref="#method.write_toml_file">write_toml_file</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-Clone-for-BasicSettings%3CA%3E">Clone</a></li><li><ahref="#impl-Debug-for-BasicSettings%3CA%3E">Debug</a></li><li><ahref="#impl-Deserialize%3C%27de%3E-for-BasicSettings%3CA%3E">Deserialize<'de></a></li><li><ahref="#impl-Eq-for-BasicSettings%3CA%3E">Eq</a></li><li><ahref="#impl-Hash-for-BasicSettings%3CA%3E">Hash</a></li><li><ahref="#impl-PartialEq%3CBasicSettings%3CA%3E%3E-for-BasicSettings%3CA%3E">PartialEq<BasicSettings<A>></a></li><li><ahref="#impl-StructuralEq-for-BasicSettings%3CA%3E">StructuralEq</a></li><li><ahref="#impl-StructuralPartialEq-for-BasicSettings%3CA%3E">StructuralPartialEq</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-BasicSettings%3CA%3E">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-BasicSettings%3CA%3E">Send</a></li><li><ahref="#impl-Sync-for-BasicSettings%3CA%3E">Sync</a></li><li><ahref="#impl-Unpin-for-BasicSettings%3CA%3E">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-BasicSettings%3CA%3E">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-BasicSettings%3CA%3E">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-BasicSettings%3CA%3E">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-BasicSettings%3CA%3E">BorrowMut<T></a></li><li><ahref="#impl-CallHasher-for-BasicSettings%3CA%3E">CallHasher</a></li><li><ahref="#impl-DeserializeOwned-for-BasicSettings%3CA%3E">DeserializeOwned</a></li><li><ahref="#impl-Equivalent%3CK%3E-for-BasicSettings%3CA%3E">Equivalent<K></a></li><li><ahref="#impl-From%3CT%3E-for-BasicSettings%3CA%3E">From<T></a></li><li><ahref="#impl-Instrument-for-BasicSettings%3CA%3E">Instrument</a></li><li><ahref="#impl-Into%3CU%3E-for-BasicSettings%3CA%3E">Into<U></a></li><li><ahref="#impl-Same%3CT%3E-for-BasicSettings%3CA%3E">Same<T></a></li><li><ahref="#impl-ToOwned-for-BasicSettings%3CA%3E">ToOwned</a></li><li><ahref="#impl-TryFrom%3CU%3E-for-BasicSettings%3CA%3E">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-BasicSettings%3CA%3E">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E-for-BasicSettings%3CA%3E">VZip<V></a></li><li><ahref="#impl-WithSubscriber-for-BasicSettings%3CA%3E">WithSubscriber</a></li></ul></section><h2><ahref="index.html">In actix_settings</a></h2></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"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="../wheel.svg"></a></div></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1class="fqn">Struct <ahref="index.html">actix_settings</a>::<wbr><aclass="struct"href="#">BasicSettings</a><b
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Wrapper for server and application-specific settings.</p>
</div></details><h2id="fields"class="fields small-section-header">Fields<ahref="#fields"class="anchor"></a></h2><spanid="structfield.actix"class="structfield small-section-header"><ahref="#structfield.actix"class="anchor field"></a><code>actix: <aclass="struct"href="struct.ActixSettings.html"title="struct actix_settings::ActixSettings">ActixSettings</a></code></span><divclass="docblock"><p>Actix Web server settings.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from_default_template"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#159-161">source</a><h4class="code-header">pub fn <ahref="#method.from_default_template"class="fnname">from_default_template</a>() -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self, <aclass="enum"href="enum.Error.html"title="enum actix_settings::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Parse an instance of <code>Self</code> straight from the default TOML template.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from_template"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#165-167">source</a><h4class="code-header">pub fn <ahref="#method.from_template"class="fnname">from_template</a>(template: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self, <aclass="enum"href="enum.Error.html"title="enum actix_settings::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Parse an instance of <code>Self</code> straight from the default TOML template.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.write_toml_file"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#174-189">source</a><h4class="code-header">pub fn <ahref="#method.write_toml_file"class="fnname">write_toml_file</a><P>(filepath: P) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="enum"href="enum.Error.html"title="enum actix_settings::Error">Error</a>><spanclass="where fmt-newline">where<br> P: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html"title="struct std::path::Path">Path</a>>,</span></h4></section></summary><divclass="docblock"><p>Writes the default TOML template to a new file, located at <code>filepath</code>.</p>
</div></details></div></details></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-BasicSettings%3CA%3E"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#105">source</a><ahref="#impl-Clone-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><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_settings/lib.rs.html#105">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="fnname">clone</a>(&self) -><aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><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="fnname">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-BasicSettings%3CA%3E"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#105">source</a><ahref="#impl-Debug-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><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_settings/lib.rs.html#105">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="fnname">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'>Format
by <code>==</code>. <ahref="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.ne"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/cmp.rs.html#227">source</a></span><ahref="#method.ne"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne"class="fnname">ne</a>(&self, other: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><divclass='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason. <ahref="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><sectionid="impl-Eq-for-BasicSettings%3CA%3E"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#105">source</a><ahref="#impl-Eq-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html"title="trait core::cmp::Eq">Eq</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html"title="trait core::cmp::Eq">Eq</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A></h3></section><sectionid="impl-StructuralEq-for-BasicSettings%3CA%3E"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#105">source</a><ahref="#impl-StructuralEq-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralEq.html"title="trait core::marker::StructuralEq">StructuralEq</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A></h3></section><sectionid="impl-StructuralPartialEq-for-BasicSettings%3CA%3E"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_settings/lib.rs.html#105">source</a><ahref="#impl-StructuralPartialEq-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html"title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A></h3></section></div><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor"></a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-BasicSettings%3CA%3E"class="impl has-srclink"><ahref="#impl-RefUnwindSafe-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html"title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A><spanclass="where fmt-newline">where<br> A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html"title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</span></h3></section><sectionid="impl-Send-for-BasicSettings%3CA%3E"class="impl has-srclink"><ahref="#impl-Send-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A><spanclass="where fmt-newline">where<br> A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a>,</span></h3></section><sectionid="impl-Sync-for-BasicSettings%3CA%3E"class="impl has-srclink"><ahref="#impl-Sync-for-BasicSettings%3CA%3E"class="anchor"></a><h3class="code-header">impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="struct.BasicSettings.html"title="struct actix_settings::BasicSettings">BasicSettings</a><A><spanclass="where fmt-newline">where<br>&n
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-BasicSettings%3CA%3E"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-BasicSettings%3CA%3E"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="fnname">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="fnname">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="fnname">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
