https://github.com/dusksystems/wayfind
A speedy, flexible router for Rust.
https://github.com/dusksystems/wayfind
router routing rust
Last synced: 17 days ago
JSON representation
A speedy, flexible router for Rust.
- Host: GitHub
- URL: https://github.com/dusksystems/wayfind
- Owner: DuskSystems
- License: apache-2.0
- Created: 2024-07-31T13:17:13.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-23T15:04:38.000Z (24 days ago)
- Last Synced: 2025-04-30T08:13:59.939Z (17 days ago)
- Topics: router, routing, rust
- Language: Rust
- Homepage: https://dusksystems.github.io/wayfind/
- Size: 1.55 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://crates.io/crates/wayfind)
[](https://docs.rs/wayfind)
[](https://codspeed.io/DuskSystems/wayfind)
[](https://codecov.io/gh/DuskSystems/wayfind)
# `wayfind`
A speedy, flexible router for Rust.
## Why another router?
`wayfind` attempts to bridge the gap between existing Rust router options:
- fast routers, lacking in flexibility
- flexible routers, lacking in speed
Real-world projects often need fancy routing capabilities, such as projects ported from frameworks like [Ruby on Rails](https://guides.rubyonrails.org/routing.html), or those adhering to specifications like the [Open Container Initiative (OCI) Distribution Specification](https://github.com/opencontainers/distribution-spec/blob/main/spec.md).
The goal of `wayfind` is to remain competitive with the fastest libraries, while offering advanced routing features when needed. Unused features shouldn't impact performance - you only pay for what you use.
## Showcase
```toml
[dependencies]
wayfind = "0.8"
```
```rust
use std::error::Error;
use wayfind::Router;
fn main() -> Result<(), Box> {
let mut router = Router::new();
router.insert("/pet(/)", 1)?;
router.insert("/pet/findByStatus(/)", 2)?;
router.insert("/pet/findByTags(/)", 3)?;
router.insert("/pet/{pet}(/)", 4)?;
router.insert("/pet/{petId:u16}/uploadImage(/)", 5)?;
router.insert("/store/inventory(/)", 6)?;
router.insert("/store/order(/{orderId:u16})(/)", 7)?;
router.insert("/user(/)", 8)?;
router.insert("/user/createWithList(/)", 9)?;
router.insert("/user/login(/)", 10)?;
router.insert("/user/logout(/)", 11)?;
router.insert("/user/{username}(/)", 12)?;
router.insert("/{*catch_all}", 13)?;
let search = router.search("/pet").unwrap();
assert_eq!(*search.data, 1);
let search = router.search("/pet/").unwrap();
assert_eq!(*search.data, 1);
let search = router.search("/pet/123/uploadImage").unwrap();
assert_eq!(*search.data, 5);
assert_eq!(search.parameters[0], ("petId", "123"));
let search = router.search("/store/order").unwrap();
assert_eq!(*search.data, 7);
let search = router.search("/store/order/456").unwrap();
assert_eq!(*search.data, 7);
assert_eq!(search.parameters[0], ("orderId", "456"));
let search = router.search("/user/alice").unwrap();
assert_eq!(*search.data, 12);
assert_eq!(search.parameters[0], ("username", "alice"));
let search = router.search("/unknown/path").unwrap();
assert_eq!(*search.data, 13);
assert_eq!(search.parameters[0], ("catch_all", "unknown/path"));
println!("{router}");
Ok(())
}
```
```
/
├─ pet [*]
│ ╰─ / [*]
│ ├─ findBy
│ │ ├─ Status [*]
│ │ │ ╰─ / [*]
│ │ ╰─ Tags [*]
│ │ ╰─ / [*]
│ ├─ {petId:u16}
│ │ ╰─ /uploadImage [*]
│ │ ╰─ / [*]
│ ╰─ {pet} [*]
│ ╰─ / [*]
├─ store/
│ ├─ inventory [*]
│ │ ╰─ / [*]
│ ╰─ order [*]
│ ╰─ / [*]
│ ╰─ {orderId:u16} [*]
│ ╰─ / [*]
├─ user [*]
│ ╰─ / [*]
│ ├─ createWithList [*]
│ │ ╰─ / [*]
│ ├─ log
│ │ ├─ in [*]
│ │ │ ╰─ / [*]
│ │ ╰─ out [*]
│ │ ╰─ / [*]
│ ╰─ {username} [*]
│ ╰─ / [*]
╰─ {*catch_all} [*]
```
## Performance
`wayfind` is fast, and appears to be competitive against other top performers in all benchmarks we currently run.
See [BENCHMARKING.md](BENCHMARKING.md) for the results.
## License
`wayfind` is licensed under the terms of both the [MIT License](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
## Inspirations
- [poem](https://github.com/poem-web/poem): Initial experimentations started out as a Poem router fork
- [matchit](https://github.com/ibraheemdev/matchit): Performance leader among pre-existing routers
- [path-tree](https://github.com/viz-rs/path-tree): Extensive testing and router display feature
- [ASP.NET Core](https://github.com/dotnet/AspNetCore): Constraints-based approach to routing