rocket_static_fs 0.5.0

A simple static file server for the rocket framework.
docs.rs failed to build rocket_static_fs-0.5.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: rocket_static_fs-0.5.1

rocket_static_fs

Build Status

A simple static file server for Rust's rocket framework.

Documentation

Features

  • Basic HTTP caching via Last-Modified header
  • Content-Encoding support (gzip and deflate)
  • Range support (no multipart ranges yet)
  • Support for multiple file backends:
    • LocalFileSystem => serve files from a local directory
    • EmbeddedFileSystem => serve files which are bundled into the binary
      • An example for that is documented on the EmbeddedFileSystem struct
    • You can add your own FileSystem implementations by implementing the fs::FileSystem trait
  • Directory listing support (no defaulting to certain files right now (e.g. index.html))

Todos

  • Cache-Control header rules
  • Directory listing default index file

Suggestions / Contributions?

Submit an issue/PR. But in almost all cases it's better to first open an issue before submitting a PR, so you don't waste your time implementing a PR which may get rejected.

Testing

Currently testing is a little bit weird. Before testing, you should cargo run once, to create a test package for the fs::embedded::Package test.

Then you can test with cargo test --all-features since the fs::embedded::Package test is currently behind a feature flag.

License

This project is licensed under either of

at your option.