https://github.com/butlerx/hyper-tree-router

Routing middleware for Hyper http library using Prefix tree (trie) for path finding.
https://github.com/butlerx/hyper-tree-router

Last synced: 15 days ago
JSON representation

Routing middleware for Hyper http library using Prefix tree (trie) for path finding.

• Host: GitHub
• URL: https://github.com/butlerx/hyper-tree-router
• Owner: butlerx
• License: mit
• Created: 2022-10-23T10:19:48.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-04T21:35:47.000Z (10 months ago)
• Last Synced: 2024-11-17T05:14:24.898Z (about 2 months ago)
• Language: Rust
• Size: 60.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Hyper Tree Router

[![Version](https://img.shields.io/crates/v/hyper-tree-router.svg?style=flat)](https://crates.io/crates/hyper-tree-router)

[![Documentation](https://img.shields.io/badge/docs-release-brightgreen.svg?style=flat)](https://docs.rs/hyper-tree-router)

[![License](https://img.shields.io/crates/l/hyper-tree-router.svg?style=flat)](https://github.com/butlerx/hyper-tree-router/blob/master/LICENSE.md)

Routing middleware for Hyper http library using Prefix tree (trie) for path

finding. Gives the ability to define routes and handlers for given request path

## Usage

To use the library add to your `Cargo.toml`

```toml

hyper = { version = "^0.14", features = ["http1", "server", "tcp"] }

hyper-tree-router = "^0.1"

```

Then you can define handlers for a given route as follows. The below code

creates two `Route` and creates a hyper server for them.

`/` with `hello_handler` that will return "Hello world" when you open the server

`/user/:user_id/home` with the `user_handler` the `url_params` contains a

hashmap of url parameters you can look up and respond to.

```rust

use hyper::{

    header::{CONTENT_LENGTH, CONTENT_TYPE},

    Body, Request, Response, Server,

};

use hyper_tree_router::{Route, RouterBuilder, UrlParams};

fn plain_text_response(body: String) -> Response {

    Response::builder()

        .header(CONTENT_LENGTH, body.len() as u64)

        .header(CONTENT_TYPE, "text/plain")

        .body(Body::from(body))

        .expect("Failed to construct response")

}

fn user_handler(url_params: UrlParams, _: Request) -> Response {

    let body = format!(

        "user: {}",

        url_params

            .captures

            .get(":user_id")

            .unwrap_or(&"unknown user".to_string())

    );

    plain_text_response(body)

}

fn hello_handler(_: UrlParams, _: Request) -> Response {

    plain_text_response("Hello World".to_string())

}

#[tokio::main]

async fn main() -> Result<(), Box> {

    let addr = "0.0.0.0:8080".parse().unwrap();

    let router = RouterBuilder::new()

        .route(Route::url("/user/:user_id/home").get(user_handler))

        .route(Route::url("/").get(hello_handler))

        .build();

    let server = Server::bind(&addr).serve(router);

    println!("Listening on http://{}", addr);

    server.await?;

    Ok(())

}

```