Struct actix_files::Files

pub struct Files { /* fields omitted */ }

Static files handling

Files service must be registered with App::service() method.

use actix_web::App;
use actix_files as fs;

fn main() {
    let app = App::new()
        .service(fs::Files::new("/static", "."));
}

Methods

impl Files

pub fn new<T: Into<PathBuf>>(path: &str, dir: T) -> Files

Create new Files instance for specified base directory.

File uses ThreadPool for blocking filesystem operations. By default pool with 5x threads of available cpus is used. Pool size can be changed by setting ACTIX_CPU_POOL environment variable.

pub fn show_files_listing(self) -> Self

Show files listing for directories.

By default show files listing is disabled.

pub fn redirect_to_slash_directory(self) -> Self

Redirects to a slash-ended path when browsing a directory.

By default never redirect.

pub fn files_listing_renderer<F>(self, f: F) -> Self where
    F: Fn(&'r Directory, &'s HttpRequest) -> Result<ServiceResponse, Error> + 'static, 

Set custom directory renderer

pub fn mime_override<F>(self, f: F) -> Self where
    F: Fn(&Name) -> DispositionType + 'static, 

Specifies mime override callback

pub fn index_file<T: Into<String>>(self, index: T) -> Self

Set index file

Shows specific index file for directory "/" instead of showing files listing.

pub fn use_etag(self, value: bool) -> Self

Specifies whether to use ETag or not.

Default is true.

pub fn use_last_modified(self, value: bool) -> Self

Specifies whether to use Last-Modified or not.

Default is true.

pub fn use_guards<G: Guard + 'static>(self, guards: G) -> Self

Specifies custom guards to use for directory listings and files.

Default behaviour allows GET and HEAD.

pub fn disable_content_disposition(self) -> Self

Disable Content-Disposition header.

By default Content-Disposition` header is enabled.

pub fn default_handler<F, U>(self, f: F) -> Self where
    F: IntoServiceFactory<U>,
    U: ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error> + 'static, 

Sets default handler which is used when no matched file could be found.

Trait Implementations

impl Clone for Files

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ServiceFactory for Files

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse

Responses given by the service

type Error = Error

Errors produced by the service

type Config = ()

Service factory configuration

type Service = FilesService

The Service value created by this factory

type InitError = ()

Errors produced while building a service.

type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>

The future of the Service instance.

fn new_service(&self, _: ()) -> Self::Future

Create and return a new service value asynchronously.

fn map<F, R>(self, f: F) -> MapServiceFactory<Self, F, R> where
    F: FnMut(Self::Response) -> R + Clone, 

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

fn map_err<F, E>(self, f: F) -> MapErrServiceFactory<Self, F, E> where
    F: Fn(Self::Error) -> E + Clone, 

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

fn map_init_err<F, E>(self, f: F) -> MapInitErr<Self, F, E> where
    F: Fn(Self::InitError) -> E + Clone, 

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

impl HttpServiceFactory for Files

fn register(self, config: &mut AppService)