added header to example main source files showing how to build & run

examples/accept/accept.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     accept`.
+//! Run   me with `zig build run-accept`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/app/auth.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     app_auth`.
+//! Run   me with `zig build run-app_auth`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/app/basic.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     app_basic`.
+//! Run   me with `zig build run-app_basic`.
+//!
 const std = @import("std");
 const Allocator = std.mem.Allocator;
 
@@ -32,7 +38,7 @@ const SimpleEndpoint = struct {
     }
 
     // handle GET requests
-    pub fn get(e: *SimpleEndpoint, arena: Allocator, context: *MyContext, r: zap.Request) anyerror!void {
+    pub fn get(e: *SimpleEndpoint, arena: Allocator, context: *MyContext, r: zap.Request) !void {
         const thread_id = std.Thread.getCurrentId();
 
         r.setStatus(.ok);
@@ -55,11 +61,11 @@ const SimpleEndpoint = struct {
     }
 
     // empty stubs for all other request methods
-    pub fn post(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) anyerror!void {}
+    pub fn post(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) !void {}
-    pub fn put(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) anyerror!void {}
+    pub fn put(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) !void {}
-    pub fn delete(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) anyerror!void {}
+    pub fn delete(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) !void {}
-    pub fn patch(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) anyerror!void {}
+    pub fn patch(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) !void {}
-    pub fn options(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) anyerror!void {}
+    pub fn options(_: *SimpleEndpoint, _: Allocator, _: *MyContext, _: zap.Request) !void {}
 };
 
 pub fn main() !void {

examples/bindataformpost/bindataformpost.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     bindataformpost`.
+//! Run   me with `zig build run-bindataformpost`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/cookies/cookies.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     cookies`.
+//! Run   me with `zig build run-cookies`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/endpoint/error.zig

@@ -0,0 +1,22 @@
+const std = @import("std");
+const zap = @import("zap");
+
+/// A simple endpoint listening on the /error route that causes an error on GET requests, which gets logged to the response (=browser) by default
+pub const ErrorEndpoint = @This();
+
+path: []const u8 = "/error",
+error_strategy: zap.Endpoint.ErrorStrategy = .log_to_response,
+
+pub fn get(e: *ErrorEndpoint, r: zap.Request) !void {
+    _ = e;
+    _ = r;
+    return error.@"Oh-no!";
+}
+
+pub fn post(_: *ErrorEndpoint, _: zap.Request) !void {}
+// pub fn post(_: *ErrorEndpoint, _: zap.Request) !void {}
+
+pub fn put(_: *ErrorEndpoint, _: zap.Request) !void {}
+pub fn delete(_: *ErrorEndpoint, _: zap.Request) !void {}
+pub fn patch(_: *ErrorEndpoint, _: zap.Request) !void {}
+pub fn options(_: *ErrorEndpoint, _: zap.Request) !void {}

examples/endpoint/main.zig

@@ -1,7 +1,14 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     endpoint`.
+//! Run   me with `zig build run-endpoint`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 const UserWeb = @import("userweb.zig");
 const StopEndpoint = @import("stopendpoint.zig");
+const ErrorEndpoint = @import("error.zig");
 
 // this is just to demo that we can catch arbitrary slugs as fallback
 fn on_request(r: zap.Request) !void {
@@ -39,10 +46,12 @@ pub fn main() !void {
         defer userWeb.deinit();
 
         var stopEp = StopEndpoint.init("/stop");
+        var errorEp: ErrorEndpoint = .{};
 
         // register endpoints with the listener
         try listener.register(&userWeb);
         try listener.register(&stopEp);
+        try listener.register(&errorEp);
 
         // fake some users
         var uid: usize = undefined;

examples/hello/hello.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     hello`.
+//! Run   me with `zig build run-hello`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/hello2/hello2.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     hello2`.
+//! Run   me with `zig build run-hello2`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/hello_json/hello_json.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     hello_json`.
+//! Run   me with `zig build run-hello_json`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/http_params/http_params.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     http_params`.
+//! Run   me with `zig build run-http_params`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/https/https.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build -Dopenssl=true     https`.
+//! Run   me with `zig build -Dopenssl=true run-https`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/middleware/middleware.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     middleware`.
+//! Run   me with `zig build run-middleware`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/middleware_with_endpoint/middleware_with_endpoint.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     middleware_with_endpoint`.
+//! Run   me with `zig build run-middleware_with_endpoint`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/mustache/mustache.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     mustache`.
+//! Run   me with `zig build run-mustache`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 const Mustache = @import("zap").Mustache;

examples/routes/routes.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     routes`.
+//! Run   me with `zig build run-routes`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/senderror/senderror.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     senderror`.
+//! Run   me with `zig build run-senderror`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/sendfile/sendfile.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     sendfile`.
+//! Run   me with `zig build run-sendfile`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/serve/serve.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     serve`.
+//! Run   me with `zig build run-serve`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/simple_router/simple_router.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     simple_router`.
+//! Run   me with `zig build run-simple_router`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 const Allocator = std.mem.Allocator;

examples/userpass_session_auth/userpass_session_auth.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     userpass_session`.
+//! Run   me with `zig build run-userpass_session`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 

examples/websockets/websockets.zig

@@ -1,3 +1,9 @@
+//!
+//! Part of the Zap examples.
+//!
+//! Build me with `zig build     websockets`.
+//! Run   me with `zig build run-websockets`.
+//!
 const std = @import("std");
 const zap = @import("zap");
 const WebSockets = zap.WebSockets;