#ryde #router #routes

ryde_router

router crate for ryde

2 releases

0.1.1 Mar 18, 2024
0.1.0 Feb 29, 2024

#2 in #ryde

Download history 141/week @ 2024-02-26 15/week @ 2024-03-04 155/week @ 2024-03-18 29/week @ 2024-04-01

186 downloads per month
Used in ryde

MIT license

8KB
137 lines

router

router is a rust enum router for axum that doesn't support nesting.

Declare your routes

use router::router;

#[router]
pub enum Route {
  #[get("/")]
  Root,
  #[get("/todos/:id/edit")]
  EditTodo(i32)
  #[put("/todos/:id")]
  UpdateTodo(i32)
}

It will complain about missing functions which you still have to write:

async fn root() -> String {
  Route::Root.to_string() // "/"
}

async fn edit_todo(Path(id): Path<i32>) -> String {
  Route::EditTodo(id).to_string() // "/todos/:id/edit"
}

async fn update_todo(Path(id): Path<i32>) -> String {
  Route::UpdateTodo(id).to_string() // "/todos/:id"
}

Use it like this

#[tokio::main]
async fn main() {
  let ip = "127.0.0.1:9001";
  let listener = tokio::net::TcpListener::bind(ip).await.unwrap();
  let router = Route::router();
  axum::serve(listener, router).await.unwrap();
}

Got state?

use std::sync::Arc;
use axum::extract::State;

struct AppState {
  count: u64
}

#[router(Arc<AppState>)]
enum Routes {
  #[get("/")]
  Index
}

async fn index(State(_st): State<Arc<AppState>>) -> String {
  Routes::Index.to_string()
}

#[tokio::main]
async fn main() {
  let ip = "127.0.0.1:9001";
  let listener = tokio::net::TcpListener::bind(ip).await.unwrap();
  let router = Routes::router().with_state(Arc::new(AppState { count: 0 }));
  axum::serve(listener, router).await.unwrap();
}

Dependencies

~1.5MB
~34K SLoC