# Ztack API Reference This document provides a comprehensive API reference for the Ztack web framework. Signatures are inferred from the project's README and code snippets, as direct access to the source files was not available in the provided context. --- ## Router (`router.zig`) The `router.zig` module provides type-safe HTTP routing, allowing you to define and dispatch requests to handlers based on method and path. ### Enums - `pub const HttpMethod = enum { GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS };`: Defines the standard HTTP methods supported by the router. ### Structs - `pub const Router = struct { ... };`: Manages the registration and dispatching of HTTP request handlers. - `pub fn init(allocator: std.mem.Allocator) Router`: Initializes a new `Router` instance with a given allocator. - `pub fn deinit(self: *Router) void`: Deinitializes the router, releasing its allocated resources. ### Functions - `pub fn register(self: *Router, method: HttpMethod, path: []const u8, handler: *const fn(HttpMethod, []const u8, []const u8) ![]const u8) !void`: Registers a handler function for a specific HTTP method and path. - `pub fn dispatch(self: *Router, method: HttpMethod, path: []const u8, body: []const u8) !?[]const u8`: Dispatches an incoming HTTP request to the registered handler that matches the method and path, returning an optional response. - `pub fn parseRequestLine(request_line: []const u8) !?[]const []const u8`: Parses an HTTP request line (e.g., "GET / HTTP/1.1") into its method and path components. - `pub fn htmlResponse(allocator: std.mem.Allocator, content: []const u8) ![]const u8`: A helper function to create a standard HTML response. - `pub fn jsonResponse(allocator: std.mem.Allocator, content: []const u8) ![]const u8`: A helper function to create a standard JSON response. - `pub fn notFoundResponse() ![]const u8`: A helper function to create a 404 Not Found HTTP response. --- ## HTML (`html.zig`) The `html.zig` module offers efficient and type-safe builders for generating HTML content, supporting direct streaming and event delegation. ### Structs - `pub const HtmlDocument = struct { ... };`: Manages the construction and rendering of an entire HTML page. - `pub fn init(allocator: std.mem.Allocator) HtmlDocument`: Initializes a new `HtmlDocument` instance. - `pub fn build(self: *HtmlDocument, head_elements: []const Element, body_elements: []const Element) ![]const u8`: Builds a complete HTML page as a byte slice from arrays of head and body elements. - `pub fn renderToWriter(self: *HtmlDocument, writer: anytype, head_elements: []const Element, body_elements: []const Element) !void`: Renders a complete HTML page directly to a provided writer without intermediate allocations. - `pub const Element = struct { ... };`: Represents a generic HTML element, serving as the return type for all HTML builder functions. ### Functions (Element Builders) - `pub fn text(content: []const u8) Element`: Creates a plain text node element. - `pub fn div(class_or_id: ?[]const u8, children: []const Element) Element`: Creates a `

` element with optional class/ID and child elements. - `pub fn h1(class: ?[]const u8, children: []const Element) Element`: Creates an `

` element with an optional class and child elements. - `pub fn h2(class: ?[]const u8, children: []const Element) Element`: Creates an `

` element with an optional class and child elements. - `pub fn p(class: ?[]const u8, children: []const Element) Element`: Creates a `
` element with an optional class and child elements. - `pub fn span(class: ?[]const u8, children: []const Element) Element`: Creates a `` element with an optional class and child elements. - `pub fn button(class: ?[]const u8, onclick: []const u8, children: []const Element) Element`: Creates a `

Ztack API Reference

Page Viewers

Guest Views