aws-sdk-rust 0.1.42

Important Enhancements: 1) Supports V2 and V4 API Signatures for third party S3 compliant products like Ceph 2) Works from behind proxies 3) Returned data can be in Rust structs, JSON or XML Works only for S3. Other AWS Storage features are coming soon! 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

<!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="API documentation for the Rust `ProfileProvider` struct in crate `aws_sdk_rust`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, ProfileProvider">

    <title>aws_sdk_rust::aws::common::credentials::ProfileProvider - Rust</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 struct">
    <!--[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>
        <p class='location'>Struct ProfileProvider</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../../../index.html'>aws_sdk_rust</a>::<wbr><a href='../../index.html'>aws</a>::<wbr><a href='../index.html'>common</a>::<wbr><a href='index.html'>credentials</a></p><script>window.sidebarCurrent = {name: 'ProfileProvider', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </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">
<h1 class='fqn'><span class='in-band'>Struct <a href='../../../index.html'>aws_sdk_rust</a>::<wbr><a href='../../index.html'>aws</a>::<wbr><a href='../index.html'>common</a>::<wbr><a href='index.html'>credentials</a>::<wbr><a class="struct" href=''>ProfileProvider</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../../../src/aws_sdk_rust/aws/common/credentials.rs.html#114-118' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct ProfileProvider { /* fields omitted */ }</pre><div class='docblock'><p>Provides AWS credentials from a profile in a credentials file.</p>

<p>The credentials file is located in the home directory of the given user by default.
You can change the <code>default</code> profile by calling <code>set_profile</code>.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/common/credentials.rs.html#278-338' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a>, <a class="struct" href="../../../../aws_sdk_rust/aws/errors/creds/struct.CredentialsError.html" title="struct aws_sdk_rust::aws::errors::creds::CredentialsError">CredentialsError</a>&gt;</code></span></h4>
<div class='docblock'><p>Create a new <code>ProfileProvider</code> for the default credentials file path and profile name.</p>

<p>More details on the AWS credentials file can be found at AWS.
Linux or Mac OS - ~/.aws/credentials
Windows - %USERPROFILE%.aws\credentials</p>

<p>Sets the &quot;default&quot; credentials but can be overridden with set_profile.</p>
</div><h4 id='method.with_profile' class="method"><span id='with_profile.v' class='invisible'><code>fn <a href='#method.with_profile' class='fnname'>with_profile</a>&lt;F, P&gt;(location: F, profile: P) -&gt; <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Create a new <code>ProfileProvider</code> for the credentials file at the given path, using
the given profile.</p>
</div><h4 id='method.location' class="method"><span id='location.v' class='invisible'><code>fn <a href='#method.location' class='fnname'>location</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a></code></span></h4>
<div class='docblock'><p>Get a reference to the credentials location.</p>
</div><h4 id='method.profile' class="method"><span id='profile.v' class='invisible'><code>fn <a href='#method.profile' class='fnname'>profile</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></h4>
<div class='docblock'><p>Get a reference to the profile name. Profile name is the subsection in the credentials
file. See AWS for details.</p>
</div><h4 id='method.set_location' class="method"><span id='set_location.v' class='invisible'><code>fn <a href='#method.set_location' class='fnname'>set_location</a>&lt;F&gt;(&amp;mut self, location: F) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Set the credentials location.</p>
</div><h4 id='method.set_profile' class="method"><span id='set_profile.v' class='invisible'><code>fn <a href='#method.set_profile' class='fnname'>set_profile</a>&lt;P&gt;(&amp;mut self, profile: P) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Set the profile name. [default] is the profile that is used by <code>default</code>. However,
you can <code>set_profile</code> with the name that matches a named profile in your credentials
file and those credentials will be used.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/common/credentials.rs.html#113' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/common/credentials.rs.html#113' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../../aws_sdk_rust/aws/common/credentials/trait.AwsCredentialsProvider.html" title="trait aws_sdk_rust::aws::common::credentials::AwsCredentialsProvider">AwsCredentialsProvider</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.ProfileProvider.html" title="struct aws_sdk_rust::aws::common::credentials::ProfileProvider">ProfileProvider</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/common/credentials.rs.html#340-346' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.credentials' class="method"><span id='credentials.v' class='invisible'><code>fn <a href='../../../../aws_sdk_rust/aws/common/credentials/trait.AwsCredentialsProvider.html#tymethod.credentials' class='fnname'>credentials</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../../../aws_sdk_rust/aws/common/credentials/struct.AwsCredentials.html" title="struct aws_sdk_rust::aws::common::credentials::AwsCredentials">AwsCredentials</a>, <a class="struct" href="../../../../aws_sdk_rust/aws/errors/creds/struct.CredentialsError.html" title="struct aws_sdk_rust::aws::errors::creds::CredentialsError">CredentialsError</a>&gt;</code></span></h4>
<div class='docblock'><p>Produce a new <code>AwsCredentials</code>.</p>
</div></div></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>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</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>