mirror of
https://github.com/actix/actix-website
synced 2024-11-25 01:02:58 +01:00
80 lines
21 KiB
HTML
80 lines
21 KiB
HTML
|
<!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 `ContentDisposition` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ContentDisposition"><title>actix_web::http::header::ContentDisposition - Rust</title><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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></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"><div class="sidebar-menu">☰</div><p class='location'>Struct ContentDisposition</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.disposition">disposition</a><a href="#structfield.parameters">parameters</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.from_raw">from_raw</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Display">Display</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a></p><script>window.sidebarCurrent = {name: 'ContentDisposition', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><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"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a>::<wbr><a class="struct" href=''>ContentDisposition</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'>−</span>]</a></span><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#92-97' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ContentDisposition {
|
|||
|
|
pub disposition: <a class="enum" href="../../../actix_web/http/header/enum.DispositionType.html" title="enum actix_web::http::header::DispositionType">DispositionType</a>,
|
|||
|
|
pub parameters: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../../../actix_web/http/header/enum.DispositionParam.html" title="enum actix_web::http::header::DispositionParam">DispositionParam</a>>,
|
|||
|
|
}</pre></div><div class='docblock'><p>A <code>Content-Disposition</code> header, (re)defined in <a href="https://tools.ietf.org/html/rfc6266">RFC6266</a>.</p>
|
|||
|
|
<p>The Content-Disposition response header field is used to convey
|
|||
|
|
additional information about how to process the response payload, and
|
|||
|
|
also can be used to attach additional metadata, such as the filename
|
|||
|
|
to use when saving the response payload locally.</p>
|
|||
|
|
<h1 id="abnf" class="section-header"><a href="#abnf">ABNF</a></h1>
|
|||
|
|
<pre><code class="language-text">content-disposition = "Content-Disposition" ":"
|
|||
|
|
disposition-type *( ";" disposition-parm )
|
|||
|
|
|
|||
|
|
disposition-type = "inline" | "attachment" | disp-ext-type
|
|||
|
|
; case-insensitive
|
|||
|
|
|
|||
|
|
disp-ext-type = token
|
|||
|
|
|
|||
|
|
disposition-parm = filename-parm | disp-ext-parm
|
|||
|
|
|
|||
|
|
filename-parm = "filename" "=" value
|
|||
|
|
| "filename*" "=" ext-value
|
|||
|
|
|
|||
|
|
disp-ext-parm = token "=" value
|
|||
|
|
| ext-token "=" ext-value
|
|||
|
|
|
|||
|
|
ext-token = <the characters in token, followed by "*">
|
|||
|
|
</code></pre>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">http</span>::<span class="ident">header</span>::{<span class="ident">ContentDisposition</span>, <span class="ident">DispositionType</span>, <span class="ident">DispositionParam</span>, <span class="ident">Charset</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">cd1</span> <span class="op">=</span> <span class="ident">ContentDisposition</span> {
|
|||
|
|
<span class="ident">disposition</span>: <span class="ident">DispositionType</span>::<span class="ident">Attachment</span>,
|
|||
|
|
<span class="ident">parameters</span>: <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">DispositionParam</span>::<span class="ident">Filename</span>(
|
|||
|
|
<span class="ident">Charset</span>::<span class="ident">Iso_8859_1</span>, <span class="comment">// The character set for the bytes of the filename</span>
|
|||
|
|
<span class="prelude-val">None</span>, <span class="comment">// The optional language tag (see `language-tag` crate)</span>
|
|||
|
|
<span class="string">b"\xa9 Copyright 1989.txt"</span>.<span class="ident">to_vec</span>() <span class="comment">// the actual bytes of the filename</span>
|
|||
|
|
)]
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">cd2</span> <span class="op">=</span> <span class="ident">ContentDisposition</span> {
|
|||
|
|
<span class="ident">disposition</span>: <span class="ident">DispositionType</span>::<span class="ident">Inline</span>,
|
|||
|
|
<span class="ident">parameters</span>: <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">DispositionParam</span>::<span class="ident">Filename</span>(
|
|||
|
|
<span class="ident">Charset</span>::<span class="ident">Ext</span>(<span class="string">"UTF-8"</span>.<span class="ident">to_owned</span>()),
|
|||
|
|
<span class="prelude-val">None</span>,
|
|||
|
|
<span class="string">"\u{2764}"</span>.<span class="ident">as_bytes</span>().<span class="ident">to_vec</span>()
|
|||
|
|
)]
|
|||
|
|
};</pre>
|
|||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.disposition" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.disposition" class="anchor field"></a>
|
|||
|
|
<span id="disposition.v" class='invisible'>
|
|||
|
|
<code>disposition: <a class="enum" href="../../../actix_web/http/header/enum.DispositionType.html" title="enum actix_web::http::header::DispositionType">DispositionType</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>The disposition</p>
|
|||
|
|
</div><span id="structfield.parameters" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.parameters" class="anchor field"></a>
|
|||
|
|
<span id="parameters.v" class='invisible'>
|
|||
|
|
<code>parameters: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../../../actix_web/http/header/enum.DispositionParam.html" title="enum actix_web::http::header::DispositionParam">DispositionParam</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>Disposition parameters</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#98-151' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from_raw' class="method"><span id='from_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.from_raw' class='fnname'>from_raw</a>(hv: &<a class="struct" href="../../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="enum" href="../../../actix_web/error/enum.ParseError.html" title="enum actix_web::error::ParseError">ParseError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#100-150' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse a raw Content-Disposition header value</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></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 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
|||
|
|
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#177-216' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/actix_web/header/common/content_disposition.rs.html#178-215' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div></div>
|
|||
|
|
<h2 id='synthetic-implementations' class='small-section-header'>
|
|||
|
|
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='synthetic-implementations-list'>
|
|||
|
|
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../actix_web/http/header/struct.ContentDisposition.html" title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|