Struct Files 

pub struct Files<Err: ErrorRenderer> { /* private fields */ }

Static files handling

Files service must be registered with App::service() method.

use ntex::web::App;
use ntex_files as fs;

let app = App::new()
   .service(fs::Files::new("/static", "."));

Implementations

impl<Err: ErrorRenderer> Files<Err>

pub fn new<T: Into<PathBuf>>(path: &str, dir: T) -> Self

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_THREADPOOL environment variable.

pub fn show_files_listing(self) -> Self

Show files listing for directories.

By default show files listing is disabled.

pub fn redirect_to_slash_directory(self) -> Self

Redirects to a slash-ended path when browsing a directory.

By default never redirect.

pub fn files_listing_renderer<F>(self, f: F) -> Self

where for<'r, 's> F: Fn(&'r Directory, &'s HttpRequest) -> Result<WebResponse, 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 use_guards<G: Guard + 'static>(self, guards: G) -> Self

Specifies custom guards to use for directory listings and files.

Default behaviour allows GET and HEAD.

pub fn disable_content_disposition(self) -> Self

Disable Content-Disposition header.

By default Content-Disposition` header is enabled.

pub fn default_handler<F, U>(self, f: F) -> Self

where F: IntoServiceFactory<U, WebRequest<Err>, SharedCfg>, U: ServiceFactory<WebRequest<Err>, SharedCfg, Response = WebResponse, Error = Err::Container> + 'static,

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

Trait Implementations

impl<Err: ErrorRenderer> Clone for Files<Err>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Err> ServiceFactory<WebRequest<Err>, SharedCfg> for Files<Err>

where Err: ErrorRenderer, Err::Container: From<FilesError>,

type Response = WebResponse

Responses given by the created services.

type Error = <Err as ErrorRenderer>::Container

Errors produced by the created services.

type Service = FilesService<Err>

The kind of Service created by this factory.

type InitError = ()

Errors potentially raised while building a service.

async fn create(&self, cfg: SharedCfg) -> Result<Self::Service, Self::InitError>

Create and return a new service value asynchronously.

async fn pipeline( &self, cfg: Cfg, ) -> Result<Pipeline<Self::Service>, Self::InitError>

where Self: Sized,

Create and return a new service value asynchronously and wrap into a container

fn map<F, Res>( self, f: F, ) -> ServiceChainFactory<MapFactory<Self, F, Req, Res, Cfg>, Req, Cfg>

where Self: Sized, F: Fn(Self::Response) -> Res + Clone,

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

fn map_err<F, E>( self, f: F, ) -> ServiceChainFactory<MapErrFactory<Self, Req, Cfg, F, E>, Req, Cfg>

where Self: Sized, F: Fn(Self::Error) -> E + Clone,

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

fn map_init_err<F, E>( self, f: F, ) -> ServiceChainFactory<MapInitErr<Self, Req, Cfg, F, E>, Req, Cfg>

where Self: Sized, F: Fn(Self::InitError) -> E + Clone,

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

impl<Err> WebServiceFactory<Err> for Files<Err>

where Err: ErrorRenderer, Err::Container: From<FilesError>,

fn register(self, config: &mut WebServiceConfig<Err>)