Windmark

Windmark is an elegant and highly performant, async Gemini server framework for the modern age!

Usage

Check out an example starter project here!

Add Windmark and Tokio as Dependencies

# Cargo.toml



[dependencies]

windmark = "0.3.1"

tokio = { version = "1.26.0", features = ["full"] }



# If you would like to use the built-in logger (recommended)

# windmark = { version = "0.3.1", features = ["logger"] }



# If you would like to use the built-in MIME dedection when `Success`-ing a file

# (recommended)

# windmark = { version = "0.3.1", features = ["auto-deduce-mime"] }



# If you would like to use macro-based responses (as seen below)

# windmark = { version = "0.3.1", features = ["response-macros"] }

Implement a Windmark server

// src/main.rs

use windmark::Response;

#[windmark::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  windmark::Router::new()
    .set_private_key_file("windmark_private.pem")
    .set_certificate_file("windmark_public.pem")
    .mount("/", windmark::success!("Hello, World!"))
    .set_error_handler(
      windmark::permanent_failure!("This route does not exist!")
    )
    .run()
    .await
}

Examples

Examples can be found within the examples/ directory.

An example of a fully featured Gemini capsule written using Windmark can be found here. This example Gemini capsule also happens to be the source code for Fuwn's (this library's author) personal Gemini capsule!

Modules

Modules are reusable extensions which can be procedurally mounted onto Windmark routers.

Add yours!

Windmark Comments

Capsules using Windmark