Struct actix_files::NamedFile[−][src]

pub struct NamedFile { /* fields omitted */ }
Expand description

A file with an associated name.

NamedFile can be registered as services:

use actix_web::App;
use actix_files::NamedFile;

let app = App::new()
    .service(NamedFile::open("./static/index.html")?);

They can also be returned from handlers:

use actix_web::{Responder, get};
use actix_files::NamedFile;

#[get("/")]
async fn index() -> impl Responder {
    NamedFile::open("./static/index.html")
}

Implementations

Creates an instance from a previously opened file.

The given path need not exist and is only used to determine the ContentType and ContentDisposition headers.

Examples

use actix_files::NamedFile;
use std::io::{self, Write};
use std::env;
use std::fs::File;

fn main() -> io::Result<()> {
    let mut file = File::create("foo.txt")?;
    file.write_all(b"Hello, world!")?;
    let named_file = NamedFile::from_file(file, "bar.txt")?;
    Ok(())
}

Attempts to open a file in read-only mode.

Examples

use actix_files::NamedFile;

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

Returns reference to the underlying File object.

Retrieve the path of this file.

Examples

use actix_files::NamedFile;

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

Set response Status Code

[src]
pub fn set_content_type(self, mime_type: Mime) -> Self

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

[src]
pub fn set_content_disposition(self, cd: ContentDisposition) -> Self

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/*, video/* and application/{javascript, json, wasm} mime types, and attachment otherwise, and the filename is taken from the path provided in the open method after converting it to UTF-8 using. std::ffi::OsStr::to_string_lossy

[src]
pub fn disable_content_disposition(self) -> Self

Disable Content-Disposition header.

By default Content-Disposition` header is enabled.

[src]
pub fn set_content_encoding(self, enc: ContentEncoding) -> Self

Set content encoding for serving this file

Must be used with [actix_web::middleware::Compress] to take effect.

Specifies whether to use ETag or not.

Default is true.

Specifies whether to use Last-Modified or not.

Default is true.

Specifies whether text responses should signal a UTF-8 encoding.

Default is false (but will default to true in a future version).

Creates an HttpResponse with file as a streaming body.

Methods from Deref<Target = File>

Attempts to sync all OS-internal metadata to disk.

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

This can be used to handle errors that would otherwise only be caught when the File is closed. Dropping a file will ignore errors in synchronizing this in-memory data.

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(())
}

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(())
}

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. Also, std::io::ErrorKind::InvalidInput will be returned if the desired length would cause an overflow due to the implementation specifics.

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.

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(())
}

Creates 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

Creates 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(())
}

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

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Convert self to HttpResponse.

Override a status code for a Responder. Read more

Insert header to the final response. Read more

Responses given by the created services.

Errors produced by the created services.

Service factory configuration.

Errors potentially raised while building a service.

The kind of Service created by this factory.

The future of the Service instance.g

Create and return a new service asynchronously.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Convert Self to a ServiceFactory

Should always be Self

Map this service’s output to a different type, returning a new service of the resulting type. Read more

Map this service’s error to a different error, returning a new service.

Map this factory’s init error to a different error, returning a new service.

Call another service after call to this one has resolved successfully.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.