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!
<!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 `HeadObjectRequest` struct in crate `aws_sdk_rust`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, HeadObjectRequest">

    <title>aws_sdk_rust::aws::s3::object::HeadObjectRequest - 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 HeadObjectRequest</p><div class="block items"><ul><li><a href="#fields">Fields</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'>s3</a>::<wbr><a href='index.html'>object</a></p><script>window.sidebarCurrent = {name: 'HeadObjectRequest', 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'>s3</a>::<wbr><a href='index.html'>object</a>::<wbr><a class="struct" href=''>HeadObjectRequest</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/s3/object.rs.html#1583-1617' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct HeadObjectRequest {
    pub sse_customer_algorithm: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerAlgorithm.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerAlgorithm">SSECustomerAlgorithm</a>&gt;,
    pub sse_customer_key: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerKey.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerKey">SSECustomerKey</a>&gt;,
    pub if_unmodified_since: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfUnmodifiedSince.html" title="type aws_sdk_rust::aws::s3::writeparse::IfUnmodifiedSince">IfUnmodifiedSince</a>&gt;,
    pub version_id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/object/type.ObjectVersionId.html" title="type aws_sdk_rust::aws::s3::object::ObjectVersionId">ObjectVersionId</a>&gt;,
    pub request_payer: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.RequestPayer.html" title="type aws_sdk_rust::aws::s3::writeparse::RequestPayer">RequestPayer</a>&gt;,
    pub bucket: <a class="type" href="../../../../aws_sdk_rust/aws/s3/bucket/type.BucketName.html" title="type aws_sdk_rust::aws::s3::bucket::BucketName">BucketName</a>,
    pub if_none_match: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfNoneMatch.html" title="type aws_sdk_rust::aws::s3::writeparse::IfNoneMatch">IfNoneMatch</a>&gt;,
    pub range: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/header/type.Range.html" title="type aws_sdk_rust::aws::s3::header::Range">Range</a>&gt;,
    pub key: <a class="type" href="../../../../aws_sdk_rust/aws/s3/object/type.ObjectKey.html" title="type aws_sdk_rust::aws::s3::object::ObjectKey">ObjectKey</a>,
    pub if_match: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfMatch.html" title="type aws_sdk_rust::aws::s3::writeparse::IfMatch">IfMatch</a>&gt;,
    pub sse_customer_key_md5: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerKeyMD5.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerKeyMD5">SSECustomerKeyMD5</a>&gt;,
    pub if_modified_since: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfModifiedSince.html" title="type aws_sdk_rust::aws::s3::writeparse::IfModifiedSince">IfModifiedSince</a>&gt;,
}</pre><h2 id='fields' class='fields'>Fields</h2><span id='structfield.sse_customer_algorithm' class="structfield">
                           <span id='sse_customer_algorithm.v' class='invisible'>
                           <code>sse_customer_algorithm: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerAlgorithm.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerAlgorithm">SSECustomerAlgorithm</a>&gt;</code>
                           </span></span><div class='docblock'><p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>
</div><span id='structfield.sse_customer_key' class="structfield">
                           <span id='sse_customer_key.v' class='invisible'>
                           <code>sse_customer_key: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerKey.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerKey">SSECustomerKey</a>&gt;</code>
                           </span></span><div class='docblock'><p>Specifies the customer-provided encryption key for Amazon S3 to use in
encrypting data. This value is used to store the object and then it is
discarded; Amazon does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the x-amz-server-side-
encryption-customer-algorithm header.</p>
</div><span id='structfield.if_unmodified_since' class="structfield">
                           <span id='if_unmodified_since.v' class='invisible'>
                           <code>if_unmodified_since: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfUnmodifiedSince.html" title="type aws_sdk_rust::aws::s3::writeparse::IfUnmodifiedSince">IfUnmodifiedSince</a>&gt;</code>
                           </span></span><div class='docblock'><p>Return the object only if it has not been modified since the specified time,
otherwise return a 412 (precondition failed).</p>
</div><span id='structfield.version_id' class="structfield">
                           <span id='version_id.v' class='invisible'>
                           <code>version_id: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/object/type.ObjectVersionId.html" title="type aws_sdk_rust::aws::s3::object::ObjectVersionId">ObjectVersionId</a>&gt;</code>
                           </span></span><div class='docblock'><p>VersionId used to reference a specific version of the object.</p>
</div><span id='structfield.request_payer' class="structfield">
                           <span id='request_payer.v' class='invisible'>
                           <code>request_payer: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.RequestPayer.html" title="type aws_sdk_rust::aws::s3::writeparse::RequestPayer">RequestPayer</a>&gt;</code>
                           </span></span><span id='structfield.bucket' class="structfield">
                           <span id='bucket.v' class='invisible'>
                           <code>bucket: <a class="type" href="../../../../aws_sdk_rust/aws/s3/bucket/type.BucketName.html" title="type aws_sdk_rust::aws::s3::bucket::BucketName">BucketName</a></code>
                           </span></span><span id='structfield.if_none_match' class="structfield">
                           <span id='if_none_match.v' class='invisible'>
                           <code>if_none_match: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfNoneMatch.html" title="type aws_sdk_rust::aws::s3::writeparse::IfNoneMatch">IfNoneMatch</a>&gt;</code>
                           </span></span><div class='docblock'><p>Return the object only if its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).</p>
</div><span id='structfield.range' class="structfield">
                           <span id='range.v' class='invisible'>
                           <code>range: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/header/type.Range.html" title="type aws_sdk_rust::aws::s3::header::Range">Range</a>&gt;</code>
                           </span></span><div class='docblock'><p>Downloads the specified range bytes of an object. For more information about
the HTTP Range header, go to
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p>
</div><span id='structfield.key' class="structfield">
                           <span id='key.v' class='invisible'>
                           <code>key: <a class="type" href="../../../../aws_sdk_rust/aws/s3/object/type.ObjectKey.html" title="type aws_sdk_rust::aws::s3::object::ObjectKey">ObjectKey</a></code>
                           </span></span><span id='structfield.if_match' class="structfield">
                           <span id='if_match.v' class='invisible'>
                           <code>if_match: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfMatch.html" title="type aws_sdk_rust::aws::s3::writeparse::IfMatch">IfMatch</a>&gt;</code>
                           </span></span><div class='docblock'><p>Return the object only if its entity tag (ETag) is the same as the one
specified, otherwise return a 412 (precondition failed).</p>
</div><span id='structfield.sse_customer_key_md5' class="structfield">
                           <span id='sse_customer_key_md5.v' class='invisible'>
                           <code>sse_customer_key_md5: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.SSECustomerKeyMD5.html" title="type aws_sdk_rust::aws::s3::writeparse::SSECustomerKeyMD5">SSECustomerKeyMD5</a>&gt;</code>
                           </span></span><div class='docblock'><p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
Amazon S3 uses this header for a message integrity check to ensure the
encryption key was transmitted without error.</p>
</div><span id='structfield.if_modified_since' class="structfield">
                           <span id='if_modified_since.v' class='invisible'>
                           <code>if_modified_since: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../../../../aws_sdk_rust/aws/s3/writeparse/type.IfModifiedSince.html" title="type aws_sdk_rust::aws::s3::writeparse::IfModifiedSince">IfModifiedSince</a>&gt;</code>
                           </span></span><div class='docblock'><p>Return the object only if it has been modified since the specified time,
otherwise return a 304 (not modified).</p>
</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/s3/object.rs.html#1582' 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="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/s3/object.rs.html#1582' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../../../../aws_sdk_rust/aws/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a></code></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Decodable.html" title="trait rustc_serialize::serialize::Decodable">Decodable</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/s3/object.rs.html#1582' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.decode' class="method"><span id='decode.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Decodable.html#tymethod.decode' class='fnname'>decode</a>&lt;__D:&nbsp;<a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Decoder.html" title="trait rustc_serialize::serialize::Decoder">Decoder</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;__arg_0: &amp;mut __D<br>) -&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/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a>, __D::<a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Decoder.html" title="trait rustc_serialize::serialize::Decoder">Error</a>&gt;</code></span></h4>
<div class='docblock'><p>Deserialize a value using a <code>Decoder</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Encodable.html" title="trait rustc_serialize::serialize::Encodable">Encodable</a> for <a class="struct" href="../../../../aws_sdk_rust/aws/s3/object/struct.HeadObjectRequest.html" title="struct aws_sdk_rust::aws::s3::object::HeadObjectRequest">HeadObjectRequest</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/aws_sdk_rust/aws/s3/object.rs.html#1582' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.encode' class="method"><span id='encode.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Encodable.html#tymethod.encode' class='fnname'>encode</a>&lt;__S:&nbsp;<a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Encoder.html" title="trait rustc_serialize::serialize::Encoder">Encoder</a>&gt;(&amp;self, __arg_0: &amp;mut __S) -&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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, __S::<a class="trait" href="https://doc.rust-lang.org/rustc-serialize/rustc_serialize/serialize/trait.Encoder.html" title="trait rustc_serialize::serialize::Encoder">Error</a>&gt;</code></span></h4>
<div class='docblock'><p>Serialize a value using an <code>Encoder</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>