<!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/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">env::VarError</span>, <span class="ident">io</span>, <span class="ident">num::ParseIntError</span>, <span class="ident">path::PathBuf</span>, <span class="ident">str::ParseBoolError</span>};
<span class="kw">use</span> <span class="ident">toml::de::Error</span> <span class="kw">as</span> <span class="ident">TomlError</span>;
<span class="doccomment">/// Convenience type alias for `Result<T, AtError>`.</span>
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">AtResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">std::result::Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">AtError</span><span class="op">></span>;
<span class="doccomment">/// Errors that can be returned from methods in this crate.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">AtError</span> {
<span class="doccomment">/// Environment variable does not exists or is invalid.</span>
<span class="ident">EnvVarError</span>(<span class="ident">VarError</span>),
<span class="doccomment">/// File already exists on disk.</span>
<span class="ident">FileExists</span>(<span class="ident">PathBuf</span>),
<span class="doccomment">/// Invalid value.</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">missing_docs</span>)]</span>
<span class="ident">InvalidValue</span> {
<span class="ident">expected</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="ident">got</span>: <span class="ident">String</span>,
<span class="ident">file</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="ident">line</span>: <span class="ident">u32</span>,
<span class="ident">column</span>: <span class="ident">u32</span>,
},
<span class="doccomment">/// I/O error.</span>
<span class="ident">IoError</span>(<span class="ident">ioe::IoError</span>),
<span class="doccomment">/// Value is not a boolean.</span>
<span class="ident">ParseBoolError</span>(<span class="ident">ParseBoolError</span>),
<span class="doccomment">/// Value is not an integer.</span>
<span class="ident">ParseIntError</span>(<span class="ident">ParseIntError</span>),
<span class="doccomment">/// Value is not an address.</span>
<span class="ident">ParseAddressError</span>(<span class="ident">String</span>),
<span class="doccomment">/// Error deserializing as TOML.</span>
<span class="ident">TomlError</span>(<span class="ident">TomlError</span>),
}
<span class="macro">macro_rules!</span> <span class="ident">InvalidValue</span> {
(<span class="ident">expected</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">expected</span>:<span class="ident">expr</span>, <span class="ident">got</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">got</span>:<span class="ident">expr</span>,) => {
<span class="ident"><span class="kw">crate</span>::AtError::InvalidValue</span> {
<span class="ident">expected</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">expected</span>,
<span class="ident">got</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">got</span>.<span class="ident">to_string</span>(),
<span class="ident">file</span>: <span class="macro">file!</span>(),
<span class="ident">line</span>: <span class="macro">line!</span>(),
<span class="ident">column</span>: <span class="macro">column!</span>(),
}
};
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">io::Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">io::Error</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::IoError</span>(<span class="ident">ioe::IoError::from</span>(<span class="ident">err</span>))
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ioe::IoError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">ioe::IoError</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::IoError</span>(<span class="ident">err</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ParseBoolError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">ParseBoolError</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::ParseBoolError</span>(<span class="ident">err</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ParseIntError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">ParseIntError</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::ParseIntError</span>(<span class="ident">err</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">TomlError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">TomlError</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::TomlError</span>(<span class="ident">err</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">VarError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AtError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">VarError</span>) -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::EnvVarError</span>(<span class="ident">err</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">AtError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">io::Error</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">AtError</span>) -> <span class="self">Self</span> {
<span class="kw">match</span> <span class="ident">err</span> {
<span class="ident">AtError::EnvVarError</span>(<span class="ident">var_error</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"Env var error: {}"</span>, <span class="ident">var_error</span>);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::FileExists</span>(<span class="ident">path_buf</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"File exists: {}"</span>, <span class="ident">path_buf</span>.<span class="ident">display</span>());
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::AlreadyExists</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::InvalidValue</span> {
<span class="ident">expected</span>,
<span class="kw-2">ref</span> <span class="ident">got</span>,
<span class="ident">file</span>,
<span class="ident">line</span>,
<span class="ident">column</span>,
} => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(
<span class="string">"Expected {}, got {} (@ {}:{}:{})"</span>,
<span class="ident">expected</span>, <span class="ident">got</span>, <span class="ident">file</span>, <span class="ident">line</span>, <span class="ident">column</span>
);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::IoError</span>(<span class="ident">io_error</span>) => <span class="ident">io_error</span>.<span class="ident">into</span>(),
<span class="ident">AtError::ParseBoolError</span>(<span class="ident">parse_bool_error</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"Failed to parse boolean: {}"</span>, <span class="ident">parse_bool_error</span>);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::ParseIntError</span>(<span class="ident">parse_int_error</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"Failed to parse integer: {}"</span>, <span class="ident">parse_int_error</span>);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::ParseAddressError</span>(<span class="ident">string</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"Failed to parse address: {}"</span>, <span class="ident">string</span>);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</span>)
}
<span class="ident">AtError::TomlError</span>(<span class="ident">toml_error</span>) => {
<span class="kw">let</span> <span class="ident">msg</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"TOML error: {}"</span>, <span class="ident">toml_error</span>);
<span class="ident">io::Error::new</span>(<span class="ident">io::ErrorKind::InvalidInput</span>, <span class="ident">msg</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.65.0-nightly (d394408fb 2022-08-07)" ></div></body></html>