Struct actix_web::fs::StaticFiles

pub struct StaticFiles<S, C = DefaultConfig> { /* fields omitted */ }

Static files handling

StaticFile handler must be registered with App::handler() method, because StaticFile handler requires access sub-path information.

use actix_web::{fs, App};

fn main() {
    let app = App::new()
        .handler("/static", fs::StaticFiles::new(".").unwrap())
        .finish();
}

Methods

impl<S: 'static> StaticFiles<S>

pub fn new<T: Into<PathBuf>>(dir: T) -> Result<StaticFiles<S>, Error>

Create new StaticFiles instance for specified base directory.

StaticFile uses CpuPool for blocking filesystem operations. By default pool with 20 threads is used. Pool size can be changed by setting ACTIX_CPU_POOL environment variable.

pub fn with_pool<T: Into<PathBuf>>(
    dir: T,
    pool: CpuPool
) -> Result<StaticFiles<S>, Error>

Create new StaticFiles instance for specified base directory and CpuPool.

impl<S: 'static, C: StaticFileConfig> StaticFiles<S, C>

pub fn with_config<T: Into<PathBuf>>(
    dir: T,
    config: C
) -> Result<StaticFiles<S, C>, Error>

Create new StaticFiles instance for specified base directory.

Identical with new but allows to specify configiration to use.

pub fn with_config_pool<T: Into<PathBuf>>(
    dir: T,
    pool: CpuPool,
    _: C
) -> Result<StaticFiles<S, C>, Error>

Create new StaticFiles instance for specified base directory with config and CpuPool.

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<S>) -> Result<HttpResponse, Error> + 'static, 

Set custom directory renderer

pub fn index_file<T: Into<String>>(self, index: T) -> StaticFiles<S, C>

Set index file

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

pub fn default_handler<H: Handler<S>>(self, handler: H) -> StaticFiles<S, C>

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

Trait Implementations

impl<S: 'static, C: 'static + StaticFileConfig> Handler<S> for StaticFiles<S, C>

type Result = Result<AsyncResult<HttpResponse>, Error>

The type of value that handler will return.

fn handle(&self, req: &HttpRequest<S>) -> Self::Result

Handle request