<!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/mod.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mod.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">
<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>
</pre><pre class="rust ">
<span class="comment">// Copyright 2017 LambdaStack All rights reserved.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="comment">// you may not use this file except in compliance with the License.</span>
<span class="comment">// You may obtain a copy of the License at</span>
<span class="comment">//</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="comment">//</span>
<span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
<span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="comment">// See the License for the specific language governing permissions and</span>
<span class="comment">// limitations under the License.</span>
<span class="comment">//</span>
<span class="doccomment">//! Each of the modules listed below contain `Client` and `Library` documentation. At the top of</span>
<span class="doccomment">//! each file the documentation identifies if the given source file is mainly used for `Client`</span>
<span class="doccomment">//! or by the `Library`. Of course, we welcome *ALL* pull requests so digging into the `Library`</span>
<span class="doccomment">//! documentation is encouraged to get an idea how `aws-sdk-rust` works.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! However, if you're only interested in how to use it from your app then skip the docs that</span>
<span class="doccomment">//! start with `Library` and focus on those that start with `Client`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! NB: ####Endpoint is the only non-unit structure that is not JSON encodable/decodable due to</span>
<span class="doccomment">//! third party Url struct. A custom to_json trait would need to be implemented. Not real impactful</span>
<span class="doccomment">//! since this struct is mainly used for initial endpoint connections.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! NB: ####CompleteMultipartUploadRequest is *not* JSON decodable without implementing a custom to_json trait</span>
<span class="doccomment">//! because of Option<&'a [u8]>. You can still encode to JSON.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! NB: ####PutObjectRequest is *not* JSON decodable without implementing a custom to_json trait</span>
<span class="doccomment">//! because of Option<&'a [u8]>. You can still encode to JSON.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! NB: ####UploadPartRequest is *not* JSON decodable without implementing a custom to_json trait</span>
<span class="doccomment">//! because of Option<&'a [u8]>. You can still encode to JSON.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Example JSON output: (see /src/main.rs for full examples)</span>
<span class="doccomment">//! use rustc_serialize::json;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let mut list_objects = ListObjectsRequest::default();</span>
<span class="doccomment">//! list_objects.bucket = bucket_name.to_string();</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! match client.list_objects(&list_objects) {</span>
<span class="doccomment">//! Ok(objects) => {</span>
<span class="doccomment">//! // Example of Serializing Rust struct</span>
<span class="doccomment">//! println!("{:#?}", objects);</span>
<span class="doccomment">//! // Example of converting to JSON. Can also call json::encode(&objects).unwrap();</span>
<span class="doccomment">//! println!("{}", json::as_pretty_json(&objects));</span>
<span class="doccomment">//! },</span>
<span class="doccomment">//! Err(e) => println!("{:#?}", e)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">/// `common` contains the type, struct, enum and impls that are common accross most requests</span>
<span class="doccomment">/// such as buckets, objects etc.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">common</span>;
<span class="doccomment">/// `errors` contains the type, struct, enum and impls of different Error Types.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">errors</span>;
<span class="doccomment">/// `s3` contains the type, struct, enum and impls of all S3 only related items. Also, it contains</span>
<span class="doccomment">/// `S3Client` which is the interface used by applications.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">s3</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>