Trait http_fs::config::StaticFileConfig

source · 
pub trait StaticFileConfig {
    type FileService: FileServeConfig + 'static;
    type DirService: DirectoryListingConfig;

    // Provided methods
    fn is_method_allowed(method: &Method) -> bool { ... }
    fn serve_dir(&self) -> &Path { ... }
    fn router_prefix(&self) -> &str { ... }
    fn index_file(&self, _path: &Path) -> Option<&Path> { ... }
    fn handle_directory(&self, _path: &Path) -> bool { ... }
    fn handle_not_found(
        &self,
        _path: &Path,
        _out_headers: &mut HeaderMap
    ) -> (StatusCode, Bytes) { ... }
}
Expand description

Configuration description

Required Associated Types§

source

type FileService: FileServeConfig + 'static

File serve configuration

source

type DirService: DirectoryListingConfig

Directory serve configuration

Provided Methods§

source

fn is_method_allowed(method: &Method) -> bool

Returns whether specified method is allowed for use. By default allows HEAD and GET

source

fn serve_dir(&self) -> &Path

Returns directory from where to serve files.

By default returns .

source

fn router_prefix(&self) -> &str

Specifies router prefix.

To be used by frameworks such as Actix

Defaults to /

source

fn index_file(&self, _path: &Path) -> Option<&Path>

Returns name of index file to show.

path points to directory relative to StaticFileConfig::serve_dir.

By default returns None

source

fn handle_directory(&self, _path: &Path) -> bool

Returns whether directory should be listed on access

path points to directory relative to StaticFileConfig::serve_dir.

By default returns false

source

fn handle_not_found( &self, _path: &Path, _out_headers: &mut HeaderMap ) -> (StatusCode, Bytes)

Handles entry that hasn’t been found.

path points to entry relative to StaticFileConfig::serve_dir.

By default prepares empty NotFound response with empty body

Object Safety§

This trait is not object safe.

Implementors§