34 lines
10 KiB
HTML
34 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="Config organizes hierarchical or layered configurations for Rust applications."><meta name="keywords" content="rust, rustlang, rust-lang, config"><title>config - Rust</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="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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="../config/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../config/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate config</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.13.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../config/index.html"><img class="rust-logo" src="../rust-logo.svg" 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="main-heading"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">config</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/config/lib.rs.html#1-44">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Config organizes hierarchical or layered configurations for Rust applications.</p>
|
||
<p>Config lets you set a set of default parameters and then extend them via merging in
|
||
configuration from a variety of sources:</p>
|
||
<ul>
|
||
<li>Environment variables</li>
|
||
<li>String literals in well-known formats</li>
|
||
<li>Another Config instance</li>
|
||
<li>Files: TOML, JSON, YAML, INI, RON, JSON5 and custom ones defined with Format trait</li>
|
||
<li>Manual, programmatic override (via a <code>.set</code> method on the Config instance)</li>
|
||
</ul>
|
||
<p>Additionally, Config supports:</p>
|
||
<ul>
|
||
<li>Live watching and re-reading of configuration files</li>
|
||
<li>Deep access into the merged configuration via a path syntax</li>
|
||
<li>Deserialization via <code>serde</code> of the configuration or any subset defined via a path</li>
|
||
</ul>
|
||
<p>See the <a href="https://github.com/mehcode/config-rs/tree/master/examples">examples</a> for
|
||
general usage information.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.AsyncConfigBuilder"><code>pub use crate::builder::<a class="struct" href="builder/struct.AsyncConfigBuilder.html" title="struct config::builder::AsyncConfigBuilder">AsyncConfigBuilder</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item" id="reexport.ConfigBuilder"><code>pub use crate::builder::<a class="struct" href="builder/struct.ConfigBuilder.html" title="struct config::builder::ConfigBuilder">ConfigBuilder</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="builder/index.html" title="config::builder mod">builder</a></div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Config.html" title="config::Config struct">Config</a></div><div class="item-right docblock-short"><p>A prioritized configuration repository. It maintains a set of
|
||
configuration sources, fetches values to populate those, and provides
|
||
them according to the source’s priority.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Environment.html" title="config::Environment struct">Environment</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.File.html" title="config::File struct">File</a></div><div class="item-right docblock-short"><p>A configuration source backed up by a file.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FileSourceFile.html" title="config::FileSourceFile struct">FileSourceFile</a></div><div class="item-right docblock-short"><p>Describes a file sourced from a file</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FileSourceString.html" title="config::FileSourceString struct">FileSourceString</a></div><div class="item-right docblock-short"><p>Describes a file sourced from a string</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Value.html" title="config::Value struct">Value</a></div><div class="item-right docblock-short"><p>A configuration value.</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ConfigError.html" title="config::ConfigError enum">ConfigError</a></div><div class="item-right docblock-short"><p>Represents all possible errors that can occur when working with
|
||
configuration.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FileFormat.html" title="config::FileFormat enum">FileFormat</a></div><div class="item-right docblock-short"><p>File formats provided by the library.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueKind.html" title="config::ValueKind enum">ValueKind</a></div><div class="item-right docblock-short"><p>Underlying kind of the configuration value.</p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsyncSource.html" title="config::AsyncSource trait">AsyncSource</a></div><div class="item-right docblock-short"><p>Describes a generic <em>source</em> of configuration properties capable of using an async runtime.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FileStoredFormat.html" title="config::FileStoredFormat trait">FileStoredFormat</a></div><div class="item-right docblock-short"><p>An extension of <a href="trait.Format.html"><code>Format</code></a> trait.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Format.html" title="config::Format trait">Format</a></div><div class="item-right docblock-short"><p>Describes a format of configuration source data</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Source.html" title="config::Source trait">Source</a></div><div class="item-right docblock-short"><p>Describes a generic <em>source</em> of configuration properties.</p>
|
||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Map.html" title="config::Map type">Map</a></div><div class="item-right docblock-short"></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="config" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |