rocket-include-static-resources 0.5.1

This is a crate which provides macros `static_resources_initialize!` and `static_response!` to statically include files from your Rust project and make them be the HTTP response sources quickly.
docs.rs failed to build rocket-include-static-resources-0.5.1
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-include-static-resources-0.10.5

Include Static Resources for Rocket Framework

This is a crate which provides macros static_resources_initialize! and static_response! to statically include files from your Rust project and make them be the HTTP response sources quickly.

Example

#![feature(plugin)]
#![plugin(rocket_codegen)]

#[macro_use] extern crate lazy_static;
#[macro_use] extern crate lazy_static_include;

#[macro_use] extern crate rocket_include_static_resources;
extern crate rocket_etag_if_none_match;

extern crate rocket;

static_resources_initialize!(
   "favicon", "included-static-resources/favicon.ico",
   "favicon-png", "included-static-resources/favicon-16.png"
);

use rocket_etag_if_none_match::EtagIfNoneMatch;

use rocket::response::Response;

#[get("/favicon.ico")]
fn favicon(etag_if_none_match: EtagIfNoneMatch) -> Response<'static> {
   static_response!(etag_if_none_match, "favicon")
}

#[get("/favicon.png")]
fn favicon_png() -> Response<'static> {
   static_response!("favicon-png")
}
  • static_resources_initialize! is used for including files into your executable binary file. You need to specify each file's ID and its path. For instance, the above example uses favicon to represent the file included-static-resources/favicon.ico and favicon_png to represent the file included-static-resources/favicon.png. An ID cannot be repeating.
  • static_response! is used for retrieving the file you input through the macro static_resources_initialize! as a Response instance into which three HTTP headers, Content-Type, Content-Length and Etag, will be automatically added.

Refer to tests/favicon.rs to see the example completely.

In order to reduce the compilation time, files are compiled into your executable binary file together, only when you are using the release profile.

License

MIT