https://github.com/magiclen/rocket-include-static-resources

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.
https://github.com/magiclen/rocket-include-static-resources

rocket static-resources

Last synced: 5 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/magiclen/rocket-include-static-resources
• Owner: magiclen
• License: mit
• Created: 2018-08-15T17:25:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-03T02:03:17.000Z (over 1 year ago)
• Last Synced: 2025-01-31T22:11:25.409Z (5 months ago)
• Topics: rocket, static-resources
• Language: Rust
• Homepage:
• Size: 148 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Include Static Resources for Rocket Framework

====================

[![CI](https://github.com/magiclen/rocket-include-static-resources/actions/workflows/ci.yml/badge.svg)](https://github.com/magiclen/rocket-include-static-resources/actions/workflows/ci.yml)

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

## Example

```rust

#[macro_use]

extern crate rocket;

#[macro_use]

extern crate rocket_include_static_resources;

use rocket::State;

use rocket_include_static_resources::{EtagIfNoneMatch, StaticContextManager, StaticResponse};

static_response_handler! {

    "/favicon.ico" => favicon => "favicon",

    "/favicon-16.png" => favicon_png => "favicon-png",

}

#[get("/")]

fn index(

    static_resources: &State,

    etag_if_none_match: EtagIfNoneMatch,

) -> StaticResponse {

    static_resources.build(&etag_if_none_match, "html-readme")

}

#[launch]

fn rocket() -> _ {

    rocket::build()

        .attach(static_resources_initializer!(

            "favicon" => "examples/front-end/images/favicon.ico",

            "favicon-png" => "examples/front-end/images/favicon-16.png",

            "html-readme" => ("examples", "front-end", "html", "README.html"),

        ))

        .mount("/", routes![favicon, favicon_png])

        .mount("/", routes![index])

}

```

* `static_resources_initializer!` is used for including files into your executable binary file. You need to specify each file's name and its path relative to the directory containing the manifest of your package. 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**. A name cannot be repeating. In order to reduce the compilation time and allow to hot-reload resources, files are compiled into your executable binary file together, only when you are using the **release** profile.

* `static_response_handler!` is used for quickly creating **GET** route handlers to retrieve static resources.

See `examples`.

## Crates.io

https://crates.io/crates/rocket-include-static-resources

## Documentation

https://docs.rs/rocket-include-static-resources

## License

[MIT](LICENSE)