Struct http_fs::StaticFiles

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

Static files service

Methods

impl<C: StaticFileConfig> StaticFiles<C>

pub fn new(config: C) -> Self

Creates new instance with provided config

pub fn workers(&self) -> &ThreadPool

Returns reference to thread pool

pub fn serve(&self, path: &Path) -> ServeEntry

Serves file

pub fn handle_not_found(
    &self,
    path: &Path,
    out_headers: &mut HeaderMap
) -> (StatusCode, Bytes)

Handles not found directory

pub fn list_dir(&self, path: &Path, dir: ReadDir) -> Bytes

Serve directory routine

pub fn serve_file(
    &self,
    path: &Path,
    file: File,
    meta: Metadata,
    method: Method,
    headers: &HeaderMap,
    out_headers: &mut HeaderMap
) -> (StatusCode, Option<ChunkedReadFile<C::FileService>>)

Serves file routine

Trait Implementations

impl<C: Clone> Clone for StaticFiles<C>

fn clone(&self) -> StaticFiles<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for StaticFiles<DefaultConfig>

fn default() -> Self

Returns the "default value" for a type.

impl<C: 'static + StaticFileConfig + Clone> NewService<()> for StaticFiles<C>

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse

Responses given by the service

type Error = Error

Errors produced by the service

type Service = Self

The Service value created by this factory

type InitError = ()

Errors produced while building a service.

type Future = FutureResult<Self::Service, Self::InitError>

The future of the Service instance.

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

Create and return a new service value asynchronously.

default fn apply<T, T1, B, B1>(
    self,
    transform: T1,
    service: B1
) -> AndThenTransform<T, Self, B, Config> where
    B: NewService<Config, InitError = Self::InitError>,
    B1: IntoNewService<B, Config>,
    T: Transform<<B as NewService<Config>>::Service, Request = Self::Response, InitError = Self::InitError>,
    T1: IntoTransform<T, <B as NewService<Config>>::Service>,
    <T as Transform<<B as NewService<Config>>::Service>>::Error: From<Self::Error>, 

Apply transform service to specified service and use it as a next service in chain.

default fn apply_fn<B, I, F, Out>(
    self,
    service: I,
    f: F
) -> AndThenApplyNewService<Self, B, F, Out, Config> where
    B: NewService<Config, Error = Self::Error, InitError = Self::InitError>,
    F: FnMut(Self::Response, &mut <B as NewService<Config>>::Service) -> Out,
    I: IntoNewService<B, Config>,
    Out: IntoFuture,
    <Out as IntoFuture>::Error: Into<Self::Error>, 

Apply function to specified service and use it as a next service in chain.

default fn apply_cfg<F, C, S, U>(
    self,
    service: U,
    f: F
) -> AndThenNewService<Self, ApplyConfig<F, S, Config, C>, Config> where
    F: Fn(&Config) -> C,
    S: NewService<C, Request = Self::Response, Error = Self::Error, InitError = Self::InitError>,
    U: IntoNewService<S, C>, 

Map this service's config type to a different config, and use for nested service

default fn and_then<F, B>(
    self,
    new_service: F
) -> AndThenNewService<Self, B, Config> where
    B: NewService<Config, Request = Self::Response, Error = Self::Error, InitError = Self::InitError>,
    F: IntoNewService<B, Config>, 

Call another service after call to this one has resolved successfully.

default fn from_err<E>(self) -> FromErrNewService<Self, E, Config> where
    E: From<Self::Error>, 

NewService that create service to map this service's error and new service's init error to any error implementing From for this servicesError`.

default fn then<F, B>(self, new_service: F) -> ThenNewService<Self, B, Config> where
    B: NewService<Config, Request = Result<Self::Response, Self::Error>, Error = Self::Error, InitError = Self::InitError>,
    F: IntoNewService<B, Config>, 

Create NewService to chain on a computation for when a call to the service finished, passing the result of the call to the next service B.

default fn map<F, R>(self, f: F) -> MapNewService<Self, F, R, Config> where
    F: FnMut(Self::Response) -> R, 

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

default fn map_err<F, E>(self, f: F) -> MapErrNewService<Self, F, E, Config> where
    F: Fn(Self::Error) -> E + Clone, 

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

default fn map_init_err<F, E>(self, f: F) -> MapInitErr<Self, F, E, Config> where
    F: Fn(Self::InitError) -> E, 

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

impl<C: 'static + StaticFileConfig + Clone> Service for StaticFiles<C>

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = FutureResult<Self::Response, Self::Error>

The future response value.

fn poll_ready(&mut self) -> Poll<(), Self::Error>

Returns Ready when the service is able to process requests.

fn call(&mut self, req: ServiceRequest) -> Self::Future

Process the request and return the response asynchronously.

impl<C: 'static + StaticFileConfig + Clone> HttpServiceFactory<Box<dyn Stream<Item = Bytes, Error = PayloadError> + 'static>> for StaticFiles<C>

fn register(self, config: &mut ServiceConfig<PayloadStream>)

impl<C: StaticFileConfig> Service for StaticFiles<C>

type ReqBody = Body

The Payload body of the http::Request.

type ResBody = Body

The Payload body of the http::Response.

type Error = Error

The error type that can occur within this Service.

type Future = FutureResult<Response<Self::ResBody>, Self::Error>

The Future returned by this Service.

fn call(&mut self, req: Request<Self::ReqBody>) -> Self::Future

Calls this Service with a request, returning a Future of the response.

default fn poll_ready(&mut self) -> Result<Async<()>, Self::Error>

Returns Ready when the service is able to process requests.

impl<C: StaticFileConfig + Clone, Ctx> MakeService<Ctx> for StaticFiles<C>

type ReqBody = Body

The Payload body of the http::Request.

type ResBody = Body

The Payload body of the http::Response.

type Error = Error

The error type that can be returned by Services.

type Service = Self

The resolved Service from new_service().

type MakeError = Error

The error type that can be returned when creating a new Service.

type Future = FutureResult<Self::Service, Self::MakeError>

The future returned from new_service of a Service.

fn make_service(&mut self, _: Ctx) -> Self::Future

Create a new Service.

default fn poll_ready(&mut self) -> Result<Async<()>, Self::MakeError>

Returns Ready when the constructor is ready to create a new Service.