# actix_web::fs::NamedFile - Rust
API documentation for the Rust `NamedFile` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, NamedFile

# Struct actix_web::fs::NamedFile [−] [src]

    pub struct NamedFile<C = DefaultConfig> { /* fields omitted */ }

A file with an associated name.

## Methods

###

`impl NamedFile`

[src]

####

`pub fn open<P: AsRef<Path>>(path: P) -> Result<NamedFile>`

[src]

Attempts to open a file in read-only mode.

# Examples

    use actix_web::fs::NamedFile;

    let file = NamedFile::open("foo.txt");

###

`impl<C: StaticFileConfig> NamedFile<C>`

[src]

####

`pub fn open_with_config<P: AsRef<Path>>(path: P, _: C) -> Result<NamedFile<C>>`

[src]

Attempts to open a file in read-only mode using provided configiration.

# Examples

    use actix_web::fs::{DefaultConfig, NamedFile};

    let file = NamedFile::open_with_config("foo.txt", DefaultConfig);

####
ⓘImportant traits for File

### Important traits for File

`impl Read for Fileimpl<'a> Read for &'a Fileimpl Write for Fileimpl<'a> Write for &'a File`

`pub fn file(&self) -> &File`

[src]

Returns reference to the underlying `File` object.

####

`pub fn path(&self) -> &Path`

[src]

Retrieve the path of this file.

# Examples

    use actix_web::fs::NamedFile;

    let file = NamedFile::open("test.txt")?;
    assert_eq!(file.path().as_os_str(), "foo.txt");

####

`pub fn set_cpu_pool(self, cpu_pool: CpuPool) -> Self`

[src]

Set `CpuPool` to use

####

`pub fn set_status_code(self, status: StatusCode) -> Self`

[src]

Set response Status Code

####

`pub fn set_content_type(self, mime_type: Mime) -> Self`

[src]

Set the MIME Content-Type for serving this file. By default the Content-Type is inferred from the filename extension.

####

`pub fn set_content_disposition(self, cd: ContentDisposition) -> Self`

[src]

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 `inline` for text, image, and video content types, and `attachment` otherwise, and the filename is taken from the path provided in the `open` method after converting it to UTF-8 using to_string_lossy.

####

`pub fn set_content_encoding(self, enc: ContentEncoding) -> Self`

[src]

Set content encoding for serving this file

## Methods from Deref<Target = File>

####

`pub fn sync_all(&self) -> Result<(), Error>`

1.0.0
[src]

Attempts to sync all OS-internal metadata to disk.

This function will attempt to ensure that all in-core data reaches the filesystem before returning.

# Examples

    use std::fs::File;
    use std::io::prelude::*;

    fn main() -> std::io::Result<()> {
        let mut f = File::create("foo.txt")?;
        f.write_all(b"Hello, world!")?;

        f.sync_all()?;
        Ok(())
    }

####

`pub fn sync_data(&self) -> Result<(), Error>`

1.0.0
[src]

This function is similar to `sync_all`, except that it may not synchronize file metadata to the filesystem.

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.

Note that some platforms may simply implement this in terms of `sync_all`.

# Examples

    use std::fs::File;
    use std::io::prelude::*;

    fn main() -> std::io::Result<()> {
        let mut f = File::create("foo.txt")?;
        f.write_all(b"Hello, world!")?;

        f.sync_data()?;
        Ok(())
    }

####

`pub fn set_len(&self, size: u64) -> Result<(), Error>`

1.0.0
[src]

Truncates or extends the underlying file, updating the size of this file to become `size`.

If the `size` 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 `size` and have all of the intermediate data filled in with 0s.

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 past the end.

# Errors

This function will return an error if the file is not opened for writing.

# Examples

    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let mut f = File::create("foo.txt")?;
        f.set_len(10)?;
        Ok(())
    }

Note that this method alters the content of the underlying file, even though it takes `&self` rather than `&mut self`.

####

`pub fn metadata(&self) -> Result<Metadata, Error>`

1.0.0
[src]

Queries metadata about the underlying file.

# Examples

    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let mut f = File::open("foo.txt")?;
        let metadata = f.metadata()?;
        Ok(())
    }

####

`pub fn try_clone(&self) -> Result<File, Error>`

1.9.0
[src]

Create a new `File` instance that shares the same underlying file handle as the existing `File` instance. Reads, writes, and seeks will affect both `File` instances simultaneously.

# Examples

Create two handles for a file named `foo.txt`:

    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let mut file = File::open("foo.txt")?;
        let file_copy = file.try_clone()?;
        Ok(())
    }

Assuming there’s a file named `foo.txt` with contents `abcdef\n`, create two handles, seek one of them, and read the remaining bytes from the other handle:

    use std::fs::File;
    use std::io::SeekFrom;
    use std::io::prelude::*;

    fn main() -> std::io::Result<()> {
        let mut file = File::open("foo.txt")?;
        let mut file_copy = file.try_clone()?;

        file.seek(SeekFrom::Start(3))?;

        let mut contents = vec![];
        file_copy.read_to_end(&mut contents)?;
        assert_eq!(contents, b"def\n");
        Ok(())
    }

####

`pub fn set_permissions(&self, perm: Permissions) -> Result<(), Error>`

1.16.0
[src]

Changes the permissions on the underlying file.

# Platform-specific behavior

This function currently corresponds to the `fchmod` function on Unix and the `SetFileInformationByHandle` function on Windows. Note that, this may change in the future.

# Errors

This function will return an error if the user lacks permission change attributes on the underlying file. It may also return an error in other os-specific unspecified cases.

# Examples

    fn main() -> std::io::Result<()> {
        use std::fs::File;

        let file = File::open("foo.txt")?;
        let mut perms = file.metadata()?.permissions();
        perms.set_readonly(true);
        file.set_permissions(perms)?;
        Ok(())
    }

Note that this method alters the permissions of the underlying file, even though it takes `&self` rather than `&mut self`.

## Trait Implementations

###

`impl<C: Debug> Debug for NamedFile<C>`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl<C> Deref for NamedFile<C>`

[src]

#### `type Target = File`

The resulting type after dereferencing.

####
ⓘImportant traits for File

### Important traits for File

`impl Read for Fileimpl<'a> Read for &'a Fileimpl Write for Fileimpl<'a> Write for &'a File`

`fn deref(&self) -> &File`

[src]

Dereferences the value.

###

`impl<C> DerefMut for NamedFile<C>`

[src]

####
ⓘImportant traits for File

### Important traits for File

`impl Read for Fileimpl<'a> Read for &'a Fileimpl Write for Fileimpl<'a> Write for &'a File`

`fn deref_mut(&mut self) -> &mut File`

[src]

Mutably dereferences the value.

###

`impl<C: StaticFileConfig> Responder for NamedFile<C>`

[src]

#### `type Item = HttpResponse`

The associated item which can be returned.

#### `type Error = Error`

The associated error which can be returned.

####

`fn respond_to<S>(self, req: &HttpRequest<S>) -> Result<HttpResponse, Error>`

[src]

Convert itself to `AsyncResult` or `Error`.

## Auto Trait Implementations

###

`impl<C> Send for NamedFile<C> where C: Send,`

###

`impl<C> Sync for NamedFile<C> where C: Sync,`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)