<!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 to the Rust file `src/aws/errors/aws.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>aws.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../../main.css">
<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../../../aws_sdk_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><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>
</pre><pre class="rust ">
<span class="comment">/*
Copyright 2017 LambdaStack All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="comment">//use aws::errors::creds::CredentialsError;</span>
<span class="kw">use</span> <span class="ident">aws</span>::<span class="ident">common</span>::<span class="ident">xmlutil</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">aws</span>::<span class="ident">common</span>::<span class="ident">common</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">aws</span>::<span class="ident">s3</span>::<span class="ident">header</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">aws</span>::<span class="ident">s3</span>::<span class="ident">writeparse</span>::<span class="kw-2">*</span>;
<span class="doccomment">/// AWSError - Default XML error returned from AWS S3.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// AWS returns a core error XML structure plus additional elements based on the type of request.</span>
<span class="doccomment">/// The ```expanded_message``` captures those additional elements if you need them.</span>
<span class="doccomment">///</span>
<span class="comment">//#[derive(Debug, Default, Clone)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">RustcDecodable</span>, <span class="ident">RustcEncodable</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AWSError</span> {
<span class="doccomment">/// code is an alphanumeric value that in some cases can be a number or a short</span>
<span class="doccomment">/// description of the issue with no spaces.</span>
<span class="kw">pub</span> <span class="ident">code</span>: <span class="ident">String</span>,
<span class="doccomment">/// host_id is the base64 encoded AWS HostId of the node that received the request.</span>
<span class="doccomment">/// This can help AWS track down issues for a given host.</span>
<span class="kw">pub</span> <span class="ident">host_id</span>: <span class="ident">String</span>,
<span class="doccomment">/// message is a full description of the error for humans.</span>
<span class="kw">pub</span> <span class="ident">message</span>: <span class="ident">String</span>,
<span class="doccomment">/// request_id is the unique ID generated for the given request coming into AWS.</span>
<span class="doccomment">/// This value is generated on every request coming into AWS to aid in tracking</span>
<span class="doccomment">/// down issues.</span>
<span class="kw">pub</span> <span class="ident">request_id</span>: <span class="ident">String</span>,
<span class="doccomment">/// resource identifies the type of AWS resource.</span>
<span class="kw">pub</span> <span class="ident">resource</span>: <span class="ident">String</span>,
<span class="doccomment">/// missing_header_name is added to the default AWSError because it's important for</span>
<span class="doccomment">/// trapping errors where header items have not been added correctly such as acl etc.</span>
<span class="kw">pub</span> <span class="ident">missing_header_name</span>: <span class="ident">String</span>,
<span class="doccomment">/// expanded_message contains the details of a given error message from AWS.</span>
<span class="kw">pub</span> <span class="ident">expanded_message</span>: <span class="ident">String</span>,
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">AWSError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"Error code: {} - {}"</span>, <span class="self">self</span>.<span class="ident">code</span>, <span class="self">self</span>.<span class="ident">description</span>())
}
}
<span class="doccomment">/// Error is implemented for AWSError for basic Error features.</span>
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">AWSError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">message</span>
}
}
<span class="doccomment">/// AWSError is the generic error XML block that AWS returns on all requests that result in some</span>
<span class="doccomment">/// sort of error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There are basic core items that return on all AWS errors plus elements that are unique to the</span>
<span class="doccomment">/// given request. For example, if the signature is incorrect (V2 or V4) for some reason then</span>
<span class="doccomment">/// the core fields will be filled in and then the ```expanded_message``` field will be updated</span>
<span class="doccomment">/// with the remaining elements that can help you track down the real issue.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// NB: AWSError is usually embedded as part of S3Error. S3Error.message will contain the</span>
<span class="doccomment">/// general error message for the given request while AWSError shows the exact AWS error.</span>
<span class="doccomment">///</span>
<span class="kw">impl</span> <span class="ident">AWSError</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">parse_xml</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Peek</span> <span class="op">+</span> <span class="ident">Next</span><span class="op">></span>(<span class="ident">tag_name</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">stack</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">AWSError</span>, <span class="ident">XmlParseError</span><span class="op">></span> {
<span class="macro">try</span><span class="macro">!</span>(<span class="ident">start_element</span>(<span class="ident">tag_name</span>, <span class="ident">stack</span>));
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">obj</span> <span class="op">=</span> <span class="ident">AWSError</span>::<span class="ident">default</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">exp_msg</span>: <span class="ident">String</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">new</span>();
<span class="kw">loop</span> {
<span class="kw">let</span> <span class="ident">current_name</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">peek_at_name</span>(<span class="ident">stack</span>));
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"HostId"</span> {
<span class="ident">obj</span>.<span class="ident">host_id</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">HostIdParser</span>::<span class="ident">parse_xml</span>(<span class="string">"HostId"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"RequestId"</span> {
<span class="ident">obj</span>.<span class="ident">request_id</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">RequestIdParser</span>::<span class="ident">parse_xml</span>(<span class="string">"RequestId"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"Code"</span> {
<span class="ident">obj</span>.<span class="ident">code</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">CodeParser</span>::<span class="ident">parse_xml</span>(<span class="string">"Code"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"Message"</span> {
<span class="ident">obj</span>.<span class="ident">message</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">S3ClientMessageParser</span>::<span class="ident">parse_xml</span>(<span class="string">"Message"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"Resource"</span> {
<span class="ident">obj</span>.<span class="ident">resource</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">ResourceParser</span>::<span class="ident">parse_xml</span>(<span class="string">"Resource"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="string">"MissingHeaderName"</span> {
<span class="ident">obj</span>.<span class="ident">missing_header_name</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">MissingHeaderNameParser</span>::<span class="ident">parse_xml</span>(<span class="string">"MissingHeaderName"</span>, <span class="ident">stack</span>));
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">current_name</span> <span class="op">==</span> <span class="ident">tag_name</span> <span class="op">||</span> <span class="ident">current_name</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="number">0</span> {
<span class="kw">break</span>;
}
<span class="comment">// No reason for listing parse error...</span>
<span class="comment">//exp_msg += &SkipElementParser::parse_xml(&current_name, stack).unwrap_or("".to_string());</span>
<span class="kw">let</span> <span class="ident">tmp</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">SkipElementParser</span>::<span class="ident">parse_xml</span>(<span class="kw-2">&</span><span class="ident">current_name</span>, <span class="ident">stack</span>).<span class="ident">unwrap_or</span>(<span class="string">""</span>.<span class="ident">to_string</span>());
<span class="ident">exp_msg</span>.<span class="ident">push_str</span>(<span class="ident">tmp</span>);
}
<span class="comment">// end_element_skip instead of end_element is used because AWSError changes based on the</span>
<span class="comment">// type of error. However, certain portions are always there and those are the ones we're</span>
<span class="comment">// interested so capture those and skip to the end.</span>
<span class="kw">if</span> <span class="ident">exp_msg</span>.<span class="ident">len</span>() <span class="op">></span> <span class="number">0</span> {
<span class="ident">obj</span>.<span class="ident">expanded_message</span> <span class="op">=</span> <span class="ident">exp_msg</span>;
}
<span class="macro">try</span><span class="macro">!</span>(<span class="ident">end_element_skip</span>(<span class="ident">tag_name</span>, <span class="ident">stack</span>));
<span class="prelude-val">Ok</span>(<span class="ident">obj</span>)
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../../";
window.currentCrate = "aws_sdk_rust";
</script>
<script src="../../../../main.js"></script>
<script defer src="../../../../search-index.js"></script>
</body>
</html>