Crate rocket_include_static_resources

Expand description

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(proc_macro_hygiene, decl_macro)]

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

#[macro_use] extern crate rocket_include_static_resources;

#[macro_use] extern crate rocket;

static_resources_initialize!(
   "favicon", "examples/front-end/favicon.ico",
   "favicon-png", "iexamples/front-end/favicon-16.png"
);

use rocket_include_static_resources::{EtagIfNoneMatch, StaticResponse};

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

#[get("/favicon.png")]
fn favicon_png() -> StaticResponse {
   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.

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

See examples.

Macros

static_resources_initialize

Used for including files into your executable binary file. You need to specify each file’s ID and its path.

static_response

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.

static_response_builder

Used for retrieving the file you input through the macro static_resources_initialize! as a ResponseBuilder instance into which three HTTP headers, Content-Type, Content-Length and Etag, will be automatically added. After fetching the ResponseBuilder instance, you can add extra headers into it!

Structs

EntityTag

An entity tag, defined in RFC7232

EtagIfNoneMatch

The request guard used for getting if-none-match header.

Type Definitions

StaticResponse