Struct actix_web_static_files::ResourceFiles

pub struct ResourceFiles { /* private fields */ }

Static resource files handling

ResourceFiles service must be registered with App::service method.

use std::collections::HashMap;

use actix_web::App;

fn main() {
// serve root directory with default options:
// - resolve index.html
    let files: HashMap<&'static str, static_files::Resource> = HashMap::new();
    let app = App::new()
        .service(actix_web_static_files::ResourceFiles::new("/", files));
// or subpath with additional option to not resolve index.html
    let files: HashMap<&'static str, static_files::Resource> = HashMap::new();
    let app = App::new()
        .service(actix_web_static_files::ResourceFiles::new("/imgs", files)
            .do_not_resolve_defaults());
}

Implementations

impl ResourceFiles

pub fn new(path: &str, files: HashMap<&'static str, Resource>) -> Self

pub fn do_not_resolve_defaults(self) -> Self

By default trying to resolve ‘…/’ to ‘…/index.html’ if it exists. Turn off this resolution by calling this function.

pub fn resolve_not_found_to<S: ToString>(self, path: S) -> Self

Resolves not found references to this path.

This can be useful for angular-like applications.

pub fn resolve_not_found_to_root(self) -> Self

Resolves not found references to root path.

This can be useful for angular-like applications.

pub fn skip_handler_when_not_found(self) -> Self

If this is called, we will use an actix_web::guard::Guard to check if this request should be handled. If set to true, we skip using the handler for files that haven’t been found, instead of sending 404s. Would be ignored, if resolve_not_found_to or resolve_not_found_to_root is used.

Can be useful if you want to share files on a (sub)path that’s also used by a different route handler.

Trait Implementations

impl Deref for ResourceFiles

type Target = ResourceFilesInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl HttpServiceFactory for ResourceFiles

fn register(self, config: &mut AppService)

impl ServiceFactory<ServiceRequest> for ResourceFiles

type Config = ()

Service factory configuration.

type Response = ServiceResponse<BoxBody>

Responses given by the created services.

type Error = Error

Errors produced by the created services.

type Service = ResourceFilesService

The kind of Service created by this factory.

type InitError = ()

Errors potentially raised while building a service.

type Future = Pin<Box<dyn Future<Output = Result<<ResourceFiles as ServiceFactory<ServiceRequest>>::Service, <ResourceFiles as ServiceFactory<ServiceRequest>>::InitError>> + 'static, Global>>

The future of the Service instance.g

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

Create and return a new service asynchronously.