Add example how to use custom HTTP methods (seanmonstar#877)

Fixes seanmonstar#871
optimizasean · Sep 7, 2021 · f490c69 · f490c69
1 parent 4f42d76
commit f490c69
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -62,3 +62,7 @@ Hooray! `warp` also includes built-in support for WebSockets
 ### Debugging
 
 - [`tracing.rs`](./tracing.rs) - Warp has built-in support for rich diagnostics with [`tracing`](https://docs.rs/tracing)!
+
+## Custom HTTP Methods
+
+- [`custom_methods.rs`](./custom_methods.rs) - It is also possible to use Warp with custom HTTP methods.
diff --git a/examples/custom_methods.rs b/examples/custom_methods.rs
@@ -0,0 +1,61 @@
+#![deny(warnings)]
+use std::net::SocketAddr;
+
+use warp::hyper::StatusCode;
+use warp::{hyper::Method, reject, Filter, Rejection, Reply};
+
+#[derive(Debug)]
+struct MethodError;
+impl reject::Reject for MethodError {}
+
+const FOO_METHOD: &'static str = "FOO";
+const BAR_METHOD: &'static str = "BAR";
+
+fn method(name: &'static str) -> impl Filter<Extract = (), Error = Rejection> + Clone {
+    warp::method()
+        .and_then(move |m: Method| async move {
+            if m == name {
+                Ok(())
+            } else {
+                Err(reject::custom(MethodError))
+            }
+        })
+        .untuple_one()
+}
+
+pub async fn handle_not_found(reject: Rejection) -> Result<impl Reply, Rejection> {
+    if reject.is_not_found() {
+        Ok(StatusCode::NOT_FOUND)
+    } else {
+        Err(reject)
+    }
+}
+
+pub async fn handle_custom(reject: Rejection) -> Result<impl Reply, Rejection> {
+    if reject.find::<MethodError>().is_some() {
+        Ok(StatusCode::METHOD_NOT_ALLOWED)
+    } else {
+        Err(reject)
+    }
+}
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let address: SocketAddr = "[::]:3030".parse()?;
+
+    let foo_route = method(FOO_METHOD)
+        .and(warp::path!("foo"))
+        .map(|| "Success")
+        .recover(handle_not_found);
+
+    let bar_route = method(BAR_METHOD)
+        .and(warp::path!("bar"))
+        .map(|| "Success")
+        .recover(handle_not_found);
+
+    warp::serve(foo_route.or(bar_route).recover(handle_custom))
+        .run(address)
+        .await;
+
+    Ok(())
+}