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 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 default_handler<F, U>(self, f: F) -> Self where
    F: IntoNewService<U>,
    U: NewService<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.

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

Performs copy-assignment from source.

impl NewService<()> 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 Service = FilesService

The Service value created by this factory

type InitError = ()

Errors produced while building a service.

type Future = Box<dyn Future<Item = Self::Service, Error = Self::InitError>>

The future of the Service instance.

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

Create and return a new service value asynchronously.

default fn apply<T, T1, B, B1>(
    self,
    transform: T1,
    service: B1
) -> AndThenTransform<T, Self, B, Config> where
    B: NewService<Config, InitError = Self::InitError>,
    B1: IntoNewService<B, Config>,
    T: Transform<<B as NewService<Config>>::Service, Request = Self::Response, InitError = Self::InitError>,
    T1: IntoTransform<T, <B as NewService<Config>>::Service>,
    <T as Transform<<B as NewService<Config>>::Service>>::Error: From<Self::Error>, 

Apply transform service to specified service and use it as a next service in chain.

default fn apply_fn<B, I, F, Out>(
    self,
    service: I,
    f: F
) -> AndThenApplyNewService<Self, B, F, Out, Config> where
    B: NewService<Config, Error = Self::Error, InitError = Self::InitError>,
    F: FnMut(Self::Response, &mut <B as NewService<Config>>::Service) -> Out,
    I: IntoNewService<B, Config>,
    Out: IntoFuture,
    <Out as IntoFuture>::Error: Into<Self::Error>, 

Apply function to specified service and use it as a next service in chain.

default fn apply_cfg<F, C, S, U>(
    self,
    service: U,
    f: F
) -> AndThenNewService<Self, ApplyConfig<F, S, Config, C>, Config> where
    F: Fn(&Config) -> C,
    S: NewService<C, Request = Self::Response, Error = Self::Error, InitError = Self::InitError>,
    U: IntoNewService<S, C>, 

Map this service's config type to a different config, and use for nested service

default fn and_then<F, B>(
    self,
    new_service: F
) -> AndThenNewService<Self, B, Config> where
    B: NewService<Config, Request = Self::Response, Error = Self::Error, InitError = Self::InitError>,
    F: IntoNewService<B, Config>, 

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

default fn from_err<E>(self) -> FromErrNewService<Self, E, Config> where
    E: From<Self::Error>, 

NewService that create service to map this service's error and new service's init error to any error implementing From for this servicesError`.

default fn then<F, B>(self, new_service: F) -> ThenNewService<Self, B, Config> where
    B: NewService<Config, Request = Result<Self::Response, Self::Error>, Error = Self::Error, InitError = Self::InitError>,
    F: IntoNewService<B, Config>, 

Create NewService to chain on a computation for when a call to the service finished, passing the result of the call to the next service B.

default fn map<F, R>(self, f: F) -> MapNewService<Self, F, R, Config> where
    F: FnMut(Self::Response) -> R, 

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

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

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

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

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

impl HttpServiceFactory for Files

fn register(self, config: &mut ServiceConfig)