mbed 0.1.0

Embed and transform assets into your Rust crate.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

<div align="center">

# mbed

Embed and transform assets into your Rust crate.

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/callum-hopkins-dev/mbed/build.yaml?branch=main&event=push&style=for-the-badge)](https://github.com/callum-hopkins-dev/mbed/actions/workflows/build.yaml)
[![Crates.io Version](https://img.shields.io/crates/v/mbed?style=for-the-badge)](https://crates.io/crates/mbed)
[![docs.rs](https://img.shields.io/docsrs/mbed?style=for-the-badge)](https://docs.rs/mbed/latest/mbed)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/mbed?style=for-the-badge)](https://crates.io/crates/mbed)
[![GitHub License](https://img.shields.io/github/license/callum-hopkins-dev/mbed?style=for-the-badge)](https://github.com/callum-hopkins-dev/mbed/blob/main/LICENSE)

</div>

## about

`mbed` provides macros for turning files and generated outputs into `Artifact`
values. Artifacts carry their bytes, MIME type, and `Id`, and can be grouped
into a `Manifest` for lookup by identifier.

### Basic usage

Requires the `macros` feature.

```rust
pub const LOGO: Artifact<[u8]> = mbed::include_bytes!["../assets/logo.svg"];
pub const INDEX: Artifact<str> = mbed::include_str!["../pages/index.html"];

let id = LOGO.id();
assert_eq!(LOGO.mime(), "image/svg+xml");
```

### Collections and manifests

`collect!` groups artifacts inside a module. `manifest!` can then reference
individual artifacts or whole collections with `::*`.

Requires the `macros` feature.

```rust
pub mod pages {
    pub const INDEX: Artifact<str> = mbed::include_str!["../pages/index.html"];
    pub const ABOUT: Artifact<str> = mbed::include_str!["../pages/about.html"];

    mbed::collect![INDEX, ABOUT];
}

pub mod images {
    pub const LOGO: Artifact<[u8]> = mbed::include_bytes!["../assets/logo.svg"];

    mbed::collect![LOGO];
}

pub const ASSETS: Manifest = mbed::manifest![pages::*, images::*];

let artifact = ASSETS.get(pages::INDEX.id()).unwrap();
assert_eq!(artifact.mime(), pages::INDEX.mime());
```

### Images

Requires the `image` feature.

```rust
pub const LOGO: Artifact<Image> = mbed::image::include! {
    resize: Scale(0.5),
    path: "../assets/logo.png",
    format: WebP,
};

assert_eq!(LOGO.format(), mbed::image::Format::WebP);
let bytes = LOGO.as_bytes();
```

### JavaScript bundles

Requires the `bundle` feature.

```rust
pub const APP: Artifact<Bundle> = mbed::js::bundle!["../frontend/app.js"];

let code = APP.code();
let sourcemap = APP.sourcemap();
```

### Tailwind CSS

Requires the `tailwindcss` feature.

```rust
pub const STYLES: Artifact<str> = mbed::css::tailwindcss!("../tailwind.css");
```

### Feature flags

- `macros` enables `include_bytes!`, `include_str!`, `collect!`, and
  `manifest!`.
- `image` enables `image:include!` and image metadata support.
- `bundle` enables `js:bundle!`.
- `tailwindcss` enables `css:tailwindcss!`.
- `serde` enables serialization support for public data types.
- `cargo-progress` shows bundling progress in Cargo build output. This feature
  is only supported on Linux.

## License

`mbed` is licensed under the MIT License. See `LICENSE` for details.

## Contributing

Contributions are welcome.

Please follow the existing code style and conventions used throughout the
project. If you're proposing a new feature or API, opening an issue first is
often the easiest way to discuss the design.