hyper-staticfile

This library exports a high-level interface Static for simple file-serving, and lower-level
interfaces for more control over responses.

Basic usage

The Static type is essentially a struct containing some settings, and a serve method to
handle the request. It follows the builder pattern, and also implements the hyper::Service
trait. It can be used as:

externcrate http;externcrate hyper_staticfile;// Instance of `Static`. Can be reused for multiple requests.let static_ =hyper_staticfile::Static::new("my/doc/root/");// A dummy request, but normally obtained from Hyper.let request =http::Request::get("/foo/bar.txt").body(()).unwrap();// Serve the request. Returns a `StaticFuture` for a response.let response_future = static_.serve(request);

Typically, you'd store the Static instance somewhere, such as in your own hyper::Service
implementation.

Advanced usage

The Static type is a simple wrapper for resolve and ResponseBuilder. You can achieve the
same by doing something similar to the following:

The resolve function tries to find the file in the root, and returns a ResolveFuture for
the ResolveResult enum, which determines what kind of response should be sent. The
ResponseBuilder is then used to create a default response. It holds some settings, and can be
constructed using the builder pattern.

It's useful to sit between these two steps to implement custom 404 pages, for example. Your
custom logic can override specific cases of ResolveResult, and fall back to the default
behavior using ResponseBuilder if necessary.

The ResponseBuilder in turn uses FileResponseBuilder to serve files that are found. The
FileResponseBuilder can also be used directly if you have an existing open tokio::fs::File
and want to serve it. It takes care of basic headers, 'not modified' responses, and streaming
the file in the body.

Finally, there's FileChunkStream, which is used by FileResponseBuilder to stream the file.
This is a struct wrapping a tokio::fs::File and implementing a futures::Stream that
produces hyper::Chunks. It can be used for streaming a file in custom response.