<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `NamedFile` struct in crate `actix_web`."><metaname="keywords"content="rust, rustlang, rust-lang, NamedFile"><title>actix_web::fs::NamedFile - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><pclass='location'>Struct NamedFile</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.open">open</a><ahref="#method.open_with_config">open_with_config</a><ahref="#method.file">file</a><ahref="#method.path">path</a><ahref="#method.set_cpu_pool">set_cpu_pool</a><ahref="#method.set_status_code">set_status_code</a><ahref="#method.set_content_type">set_content_type</a><ahref="#method.set_content_disposition">set_content_disposition</a><ahref="#method.set_content_encoding">set_content_encoding</a></div><aclass="sidebar-title"href="#deref-methods">Methods from Deref<Target=File></a><divclass="sidebar-links"><ahref="#method.sync_all">sync_all</a><ahref="#method.sync_data">sync_data</a><ahref="#method.set_len">set_len</a><ahref="#method.metadata">metadata</a><ahref="#method.try_clone">try_clone</a><ahref="#method.set_permissions">set_permissions</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Debug">Debug</a><ahref="#impl-Deref">Deref</a><ahref="#impl-DerefMut">DerefMut</a><ahref="#impl-Responder">Responder</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a></div></div><pclass='location'><ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>fs</a></p><script>window.sidebarCurrent={name:'NamedFile',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><inputclass="search-input"name="search"autocomplete="off"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='in-band'>Struct <ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>fs</a>::<wbr><aclass="struct"href=''>NamedFile</a></span><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../src/actix_web/fs.rs.html#109-120'title='goto source code'>[src]</a></span></h1><divclass="docblock type-decl"><preclass='rust struct'>pub struct NamedFile<C = <aclass="struct"href="../../actix_web/fs/struct.DefaultConfig.html"title="struct actix_web::fs::DefaultConfig">DefaultConfig</a>> { /* fields omitted */ }</pre></div><divclass='docblock'><p>A file with an associated name.</p>
</div>
<h2id='methods'class='small-section-header'>
Methods<ahref='#methods'class='anchor'></a>
</h2>
<h3id='impl'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a></code><ahref='#impl'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#122-135'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.open'class="method"><spanid='open.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.open'class='fnname'>open</a><P: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html"title="struct std::path::Path">Path</a>>>(path: P) -><aclass="type"href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html"title="type std::io::error::Result">Result</a><<aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#132-134'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Attempts to open a file in read-only mode.</p>
</div></div><h3id='impl-1'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<C: <aclass="trait"href="../../actix_web/fs/trait.StaticFileConfig.html"title="trait actix_web::fs::StaticFileConfig">StaticFileConfig</a>><aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a><C></code><ahref='#impl-1'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#137-291'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.open_with_config'class="method"><spanid='open_with_config.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.open_with_config'class='fnname'>open_with_config</a><P: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html"title="struct std::path::Path">Path</a>>>(path: P, _: C) -><aclass="type"href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html"title="type std::io::error::Result">Result</a><<aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a><C>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#147-193'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Attempts to open a file in read-only mode using provided configiration.</p>
</div><h4id='method.path'class="method"><spanid='path.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.path'class='fnname'>path</a>(&self) ->&<aclass="struct"href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html"title="struct std::path::Path">Path</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#216-218'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Retrieve the path of this file.</p>
</div><h4id='method.set_content_type'class="method"><spanid='set_content_type.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.set_content_type'class='fnname'>set_content_type</a>(self, mime_type: <aclass="struct"href="https://docs.rs/mime/0.3.8/mime/struct.Mime.html"title="struct mime::Mime">Mime</a>) -> Self</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#236-239'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Set the MIME Content-Type for serving this file. By default
the Content-Type is inferred from the filename extension.</p>
</div><h4id='method.set_content_disposition'class="method"><spanid='set_content_disposition.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.set_content_disposition'class='fnname'>set_content_disposition</a>(self, cd: <aclass="struct"href="../../actix_web/http/header/struct.ContentDisposition.html"title="struct actix_web::http::header::ContentDisposition">ContentDisposition</a>) -> Self</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#249-252'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Set the Content-Disposition for serving this file. This allows
changing the inline/attachment disposition as well as the filename
sent to the peer. By default the disposition is <code>inline</code> for text,
image, and video content types, and <code>attachment</code> otherwise, and
the filename is taken from the path provided in the <code>open</code> method
Methods from <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html"title="trait core::ops::deref::Deref">Deref</a><Target = <aclass="struct"href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html"title="struct std::fs::File">File</a>><ahref='#deref-methods'class='anchor'></a>
</h2>
<divclass='impl-items'><h4id='method.sync_all'class="method"><spanid='sync_all.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.sync_all'class='fnname'>sync_all</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.0.0'>1.0.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#412-414'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Attempts to sync all OS-internal metadata to disk.</p>
<p>This function will attempt to ensure that all in-core data reaches the
</div><h4id='method.sync_data'class="method"><spanid='sync_data.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.sync_data'class='fnname'>sync_data</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.0.0'>1.0.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#443-445'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>This function is similar to <ahref="struct.File.html#method.sync_all"><code>sync_all</code></a>, except that it may not
synchronize file metadata to the filesystem.</p>
<p>This is intended for use cases that must synchronize content, but don't
need the metadata on disk. The goal of this method is to reduce disk
operations.</p>
<p>Note that some platforms may simply implement this in terms of
</div><h4id='method.set_len'class="method"><spanid='set_len.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.set_len'class='fnname'>set_len</a>(&self, size: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.0.0'>1.0.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#478-480'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Truncates or extends the underlying file, updating the size of
this file to become <code>size</code>.</p>
<p>If the <code>size</code> is less than the current file's size, then the file will
be shrunk. If it is greater than the current file's size, then the file
will be extended to <code>size</code> and have all of the intermediate data filled
in with 0s.</p>
<p>The file's cursor isn't changed. In particular, if the cursor was at the
end and the file is shrunk using this operation, the cursor will now be
<p>Note that this method alters the content of the underlying file, even
though it takes <code>&self</code> rather than <code>&mut self</code>.</p>
</div><h4id='method.metadata'class="method"><spanid='metadata.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.metadata'class='fnname'>metadata</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/fs/struct.Metadata.html"title="struct std::fs::Metadata">Metadata</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.0.0'>1.0.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#496-498'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Queries metadata about the underlying file.</p>
</div><h4id='method.try_clone'class="method"><spanid='try_clone.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.try_clone'class='fnname'>try_clone</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html"title="struct std::fs::File">File</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.9.0'>1.9.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#540-544'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Create a new <code>File</code> instance that shares the same underlying file handle
as the existing <code>File</code> instance. Reads, writes, and seeks will affect
both <code>File</code> instances simultaneously.</p>
</div><h4id='method.set_permissions'class="method"><spanid='set_permissions.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.set_permissions'class='fnname'>set_permissions</a>(&self, perm: <aclass="struct"href="https://doc.rust-lang.org/nightly/std/fs/struct.Permissions.html"title="struct std::fs::Permissions">Permissions</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html"title="struct std::io::error::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><divclass='since'title='Stable since Rust version 1.16.0'>1.16.0</div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/fs.rs.html#579-581'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Changes the permissions on the underlying file.</p>
<divid='implementations-list'><h3id='impl-Debug'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<C: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a><C></code><ahref='#impl-Debug'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#108'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.fmt'class="method"><spanid='fmt.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#108'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a>
</h2>
<divid='synthetic-implementations-list'>
<h3id='impl-Send'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<C><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a><C><spanclass="where fmt-newline">where<br> C: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a>, </span></code><ahref='#impl-Send'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<C><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../../actix_web/fs/struct.NamedFile.html"title="struct actix_web::fs::NamedFile">NamedFile</a><C><spanclass="where fmt-newline">where<br> C: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a>, </span></code><ahref='#impl-Sync'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
