# actix_web::fs::StaticFiles - Rust
API documentation for the Rust `StaticFiles` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, StaticFiles

# Struct actix_web::fs::StaticFiles [−] [src]

    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>`

[src]

####

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

[src]

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>`

[src]

Create new `StaticFiles` instance for specified base directory and `CpuPool`.

###

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

[src]

####

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

[src]

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>`

[src]

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

####

`pub fn show_files_listing(self) -> Self`

[src]

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,`

[src]

Set custom directory renderer

####

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

[src]

Set index file

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

####

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

[src]

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>`

[src]

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

The type of value that handler will return.

####

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

[src]

Handle request

## Auto Trait Implementations

###

`impl<S, C = DefaultConfig> !Send for StaticFiles<S, C>`

###

`impl<S, C = DefaultConfig> !Sync for StaticFiles<S, C>`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)