blob: 575fb82150b3a65d42d54b7bf300a297705118de (
plain) (
blame)
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
|
# Windmark
[](https://crates.io/crates/windmark)
[](https://docs.rs/windmark)
[](https://github.com/gemrest/windmark/actions/workflows/check.yaml)
Windmark is an elegant and highly performant, async Gemini server framework.
## Usage
### Add Windmark as a dependency
```toml
# Cargo.toml
[dependencies]
windmark = "0.1.6"
tokio = { version = "0.2.4", features = ["full"] }
# If you would like to use the built-in logger (recommended)
# windmark = { version = "0.1.6", features = ["logger"] }
```
### Implement a Windmark server
```rust
// src/main.rs
use windmark::Response;
#[windmark::main]
fn main() -> Result<(), Box<dyn std::error::Error>> {
windmark::Router::new()
.set_private_key_file("windmark_private.pem")
.set_certificate_chain_file("windmark_public.pem")
.mount("/", Box::new(|_| Response::Success("Hello, World!".into())))
.set_error_handler(Box::new(|_| {
Response::PermanentFailure("This route does not exist!".into())
}))
.run()
.await
}
```
## Examples
Examples can be found within the
[`examples/`](https://github.com/gemrest/windmark/tree/main/examples) directory.
## License
This project is licensed with the
[GNU General Public License v3.0](https://github.com/gemrest/windmark/blob/main/LICENSE).
|