Begin work on OCI example.

.gitignore

@@ -21,6 +21,10 @@ corpus
 artifacts
 coverage
 
+# OCI
+junit.xml
+report.html
+
 # Nix
 result
 result-dev

CHANGELOG.md

@@ -7,7 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-...
+### Changed
+
+- Fleshed out hyper example.
+
+### Fixed
+
+- Router display no longer relies on generic being displayable.
 
 ## [0.2.0] - 2024-08-29
 

Cargo.toml

@@ -13,9 +13,22 @@ license = "MIT OR Apache-2.0"
 keywords = ["router"]
 categories = ["network-programming", "web-programming"]
 
+# https://doc.rust-lang.org/rustc/lints/groups.html
 [workspace.lints.rust]
 unsafe_code = "forbid"
 
+future-incompatible = { level = "deny", priority = -1 }
+keyword-idents = { level = "deny", priority = -1 }
+let-underscore = { level = "deny", priority = -1 }
+nonstandard-style = { level = "deny", priority = -1 }
+refining-impl-trait = { level = "deny", priority = -1 }
+rust-2018-compatibility = { level = "deny", priority = -1 }
+rust-2018-idioms = { level = "deny", priority = -1 }
+rust-2021-compatibility = { level = "deny", priority = -1 }
+rust-2024-compatibility = { level = "deny", priority = -1 }
+unused = { level = "deny", priority = -2 }
+
+# https://rust-lang.github.io/rust-clippy/master/index.html
 [workspace.lints.clippy]
 cargo = { level = "deny", priority = -1 }
 complexity = { level = "deny", priority = -1 }

README.md

@@ -280,7 +280,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     router.insert("/user/logout", 12)?;
     router.insert("/user/{username}", 13)?;
 
-    assert_eq!(router.to_string(), ROUTER_DISPLAY.trim_start());
+    assert_eq!(router.to_string(), ROUTER_DISPLAY.trim());
     Ok(())
 }
 ```

benches/matchit_divan.rs

@@ -18,7 +18,7 @@ fn main() {
 }
 
 #[divan::bench(name = "wayfind")]
-fn wayfind(bencher: divan::Bencher) {
+fn wayfind(bencher: divan::Bencher<'_, '_>) {
     let mut router = wayfind::Router::new();
     for route in routes!(brackets) {
         router.insert(route, true).unwrap();
@@ -35,7 +35,7 @@ fn wayfind(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "actix-router")]
-fn actix_router(bencher: divan::Bencher) {
+fn actix_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = actix_router::Router::<bool>::build();
     for route in routes!(brackets) {
         router.path(route, true);
@@ -54,7 +54,7 @@ fn actix_router(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "matchit")]
-fn matchit(bencher: divan::Bencher) {
+fn matchit(bencher: divan::Bencher<'_, '_>) {
     let mut router = matchit::Router::new();
     for route in routes!(brackets) {
         router.insert(route, true).unwrap();
@@ -71,7 +71,7 @@ fn matchit(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "ntex-router")]
-fn ntex_router(bencher: divan::Bencher) {
+fn ntex_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = ntex_router::Router::<bool>::build();
     for route in routes!(brackets) {
         router.path(route, true);
@@ -90,7 +90,7 @@ fn ntex_router(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "path-tree")]
-fn path_tree(bencher: divan::Bencher) {
+fn path_tree(bencher: divan::Bencher<'_, '_>) {
     let mut router = path_tree::PathTree::new();
     for route in routes!(colon) {
         let _ = router.insert(route, true);
@@ -107,7 +107,7 @@ fn path_tree(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "route-recognizer")]
-fn route_recognizer(bencher: divan::Bencher) {
+fn route_recognizer(bencher: divan::Bencher<'_, '_>) {
     let mut router = route_recognizer::Router::new();
     for route in routes!(colon) {
         router.add(route, true);
@@ -124,7 +124,7 @@ fn route_recognizer(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "routefinder")]
-fn routefinder(bencher: divan::Bencher) {
+fn routefinder(bencher: divan::Bencher<'_, '_>) {
     let mut router = routefinder::Router::new();
     for route in routes!(colon) {
         router.add(route, true).unwrap();
@@ -141,7 +141,7 @@ fn routefinder(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "xitca-router")]
-fn xitca_router(bencher: divan::Bencher) {
+fn xitca_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = xitca_router::Router::new();
     for route in routes!(colon) {
         router.insert(route, true).unwrap();

benches/path_tree_divan.rs

@@ -18,7 +18,7 @@ fn main() {
 }
 
 #[divan::bench(name = "wayfind")]
-fn wayfind(bencher: divan::Bencher) {
+fn wayfind(bencher: divan::Bencher<'_, '_>) {
     let mut router = wayfind::Router::new();
     for (index, route) in routes!(brackets).iter().enumerate() {
         router.insert(route, index).unwrap();
@@ -35,7 +35,7 @@ fn wayfind(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "actix-router")]
-fn actix_router(bencher: divan::Bencher) {
+fn actix_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = actix_router::Router::<usize>::build();
     for (index, route) in routes!(brackets).iter().enumerate() {
         router.path(*route, index);
@@ -54,7 +54,7 @@ fn actix_router(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "matchit")]
-fn matchit(bencher: divan::Bencher) {
+fn matchit(bencher: divan::Bencher<'_, '_>) {
     let mut router = matchit::Router::new();
     for (index, route) in routes!(brackets).iter().enumerate() {
         router.insert(*route, index).unwrap();
@@ -71,7 +71,7 @@ fn matchit(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "ntex-router")]
-fn ntex_router(bencher: divan::Bencher) {
+fn ntex_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = ntex_router::Router::<usize>::build();
     for (index, route) in routes!(brackets).iter().enumerate() {
         router.path(*route, index);
@@ -90,7 +90,7 @@ fn ntex_router(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "path-tree")]
-fn path_tree(bencher: divan::Bencher) {
+fn path_tree(bencher: divan::Bencher<'_, '_>) {
     let mut router = path_tree::PathTree::new();
     for (index, route) in routes!(colon).iter().enumerate() {
         let _ = router.insert(route, index);
@@ -107,7 +107,7 @@ fn path_tree(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "route-recognizer")]
-fn route_recognizer(bencher: divan::Bencher) {
+fn route_recognizer(bencher: divan::Bencher<'_, '_>) {
     let mut router = route_recognizer::Router::<usize>::new();
     for (index, route) in routes!(colon).iter().enumerate() {
         router.add(route, index);
@@ -124,7 +124,7 @@ fn route_recognizer(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "routefinder")]
-fn routefinder(bencher: divan::Bencher) {
+fn routefinder(bencher: divan::Bencher<'_, '_>) {
     let mut router = routefinder::Router::new();
     for (index, route) in routes!(colon).iter().enumerate() {
         router.add(*route, index).unwrap();
@@ -141,7 +141,7 @@ fn routefinder(bencher: divan::Bencher) {
 }
 
 #[divan::bench(name = "xitca-router")]
-fn xitca_router(bencher: divan::Bencher) {
+fn xitca_router(bencher: divan::Bencher<'_, '_>) {
     let mut router = xitca_router::Router::new();
     for (index, route) in routes!(colon).iter().enumerate() {
         router.insert(*route, index).unwrap();

examples/hyper/Cargo.toml

@@ -7,7 +7,6 @@ publish = false
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-rust-version.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
@@ -28,3 +27,4 @@ bytes = "1.7"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 anyhow = "1.0"
+regex = "1.10"

examples/hyper/README.md

@@ -0,0 +1,7 @@
+# `hyper` example
+
+This is a mini implementation of an [Open Container Initiative (OCI) Distribution Specification](https://github.com/opencontainers/distribution-spec/blob/main/spec.md) registry.
+
+## Inspirations:
+- https://github.com/mcronce/oci-registry
+- https://github.com/Trow-Registry/trow

examples/hyper/src/main.rs

@@ -1,54 +1,28 @@
-#![allow(clippy::unused_async)]
-
-use bytes::Bytes;
-use http_body_util::{combinators::BoxBody, BodyExt, Full};
-use hyper::{body::Incoming, header, service::service_fn, Request, Response, StatusCode};
+use hyper::{body::Incoming, service::service_fn, Request};
 use hyper_util::{
     rt::{TokioExecutor, TokioIo},
     server::conn::auto::Builder,
 };
+use routes::router;
 use std::{
-    convert::Infallible,
-    future::Future,
     net::{IpAddr, Ipv4Addr, SocketAddr},
-    pin::Pin,
     sync::Arc,
 };
 use tokio::{net::TcpListener, task::JoinSet};
-use wayfind::{Parameter, Path, Router};
-
-type BoxFuture<'a> = Pin<
-    Box<
-        dyn Future<Output = Result<Response<BoxBody<Bytes, Infallible>>, anyhow::Error>>
-            + Send
-            + 'a,
-    >,
->;
+use wayfind::Path;
 
-type HandlerFn =
-    Arc<dyn for<'a> Fn(&'a str, &'a [Parameter<'_, 'a>]) -> BoxFuture<'a> + Send + Sync>;
+pub mod routes;
 
 #[tokio::main]
 async fn main() -> Result<(), anyhow::Error> {
-    let mut router: Router<HandlerFn> = Router::new();
-    router.insert(
-        "/",
-        Arc::new(move |path, parameters| Box::pin(index_route(path, parameters))),
-    )?;
-    router.insert(
-        "/hello/{name}",
-        Arc::new(move |path, parameters| Box::pin(hello_route(path, parameters))),
-    )?;
-    router.insert(
-        "{*catch_all}",
-        Arc::new(move |path, parameters| Box::pin(not_found(path, parameters))),
-    )?;
-
     let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 1337);
     let listener = TcpListener::bind(&socket).await?;
     println!("Listening on http://{socket}");
 
+    let router = router()?;
     let router = Arc::new(router);
+    println!("Router: {router}");
+
     let mut join_set = JoinSet::new();
 
     loop {
@@ -58,7 +32,7 @@ async fn main() -> Result<(), anyhow::Error> {
 
         let router = Arc::clone(&router);
         join_set.spawn(async move {
-            let _ = Builder::new(TokioExecutor::new())
+            let _unused = Builder::new(TokioExecutor::new())
                 .serve_connection(
                     TokioIo::new(stream),
                     service_fn(move |request: Request<Incoming>| {
@@ -81,53 +55,3 @@ async fn main() -> Result<(), anyhow::Error> {
         });
     }
 }
-
-async fn index_route(
-    _: &'_ str,
-    _: &'_ [Parameter<'_, '_>],
-) -> Result<Response<BoxBody<Bytes, Infallible>>, anyhow::Error> {
-    let json = serde_json::json!({
-        "hello": "world"
-    });
-
-    let body = Full::new(Bytes::from(json.to_string()));
-    let response = Response::builder()
-        .header(header::CONTENT_TYPE, "application/json")
-        .body(body.boxed())?;
-
-    Ok(response)
-}
-
-async fn hello_route(
-    _: &'_ str,
-    parameters: &'_ [Parameter<'_, '_>],
-) -> Result<Response<BoxBody<Bytes, Infallible>>, anyhow::Error> {
-    let name = parameters[0].value;
-    let json = serde_json::json!({
-        "hello": name,
-    });
-
-    let body = Full::new(Bytes::from(json.to_string()));
-    let response = Response::builder()
-        .header(header::CONTENT_TYPE, "application/json")
-        .body(body.boxed())?;
-
-    Ok(response)
-}
-
-async fn not_found(
-    path: &'_ str,
-    _: &'_ [Parameter<'_, '_>],
-) -> Result<Response<BoxBody<Bytes, Infallible>>, anyhow::Error> {
-    let json = serde_json::json!({
-        "error": "route_not_found",
-        "route": path,
-    });
-
-    let body = Full::new(Bytes::from(json.to_string()));
-    let response = Response::builder()
-        .status(StatusCode::NOT_FOUND)
-        .body(body.boxed())?;
-
-    Ok(response)
-}

examples/hyper/src/routes.rs

@@ -0,0 +1,32 @@
+#![allow(clippy::unused_async)]
+
+use bytes::Bytes;
+use http_body_util::combinators::BoxBody;
+use hyper::Response;
+use index::index_route;
+use std::{convert::Infallible, future::Future, pin::Pin, sync::Arc};
+use wayfind::{errors::InsertError, Parameter, Router};
+
+pub mod index;
+
+type BoxFuture<'a> = Pin<
+    Box<
+        dyn Future<Output = Result<Response<BoxBody<Bytes, Infallible>>, anyhow::Error>>
+            + Send
+            + 'a,
+    >,
+>;
+
+type HandlerFn =
+    Arc<dyn for<'a> Fn(&'a str, &'a [Parameter<'_, 'a>]) -> BoxFuture<'a> + Send + Sync>;
+
+pub fn router() -> Result<Router<HandlerFn>, InsertError> {
+    let mut router: Router<HandlerFn> = Router::new();
+
+    router.insert(
+        "/",
+        Arc::new(move |path, parameters| Box::pin(index_route(path, parameters))),
+    )?;
+
+    Ok(router)
+}