Bolt

A blazing-fast web framework for Ring

---

Overview

Bolt brings modern web development to Ring. It pairs an Express.js-like DSL with a Rust-powered HTTP engine, giving you a framework that is both approachable and fast. Write routes in Ring, run them on a Rust async runtime.

---

🚀 Quick Start

One line is all it takes:

load "bolt.ring"
new Bolt() { $bolt.send("Hello, World!") }

A real app with routing, params, and JSON:

load "bolt.ring"

new Bolt() {
    port = 3000

    @get("/", func {
        $bolt.send("Hello from Bolt!")
    })

    @get("/users/:id", func {
        $bolt.json([
            :id   = $bolt.param("id"),
            :name = "User " + $bolt.param("id")
        ])
    })
    where("id", "[0-9]+")

    @post("/users", func {
        data = $bolt.jsonBody()
        $bolt.jsonWithStatus(201, [:created = true, :data = data])
    })
}

ring app.ring
# [bolt] Server running on http://0.0.0.0:3000

---

✨ Features

Routing & HTTP

• All HTTP methods: @get, @post, @put, @patch, @delete, @head, @options
• URL parameters (:id), query strings, and regex constraints (where())
• Route prefixes for clean API versioning (prefix() / endPrefix())
• Static file serving with automatic MIME detection

Middleware & Lifecycle

• Global @before / @after hooks
• Named middleware via @use
• Per-route middleware and rate limiting

Real-time

• WebSocket endpoints with per-client send, rooms, and broadcast
• Server-Sent Events for push updates

Security

• JWT encode / decode / verify with expiry
• Basic Auth, signed & flash cookies, CSRF tokens
• Rate limiting, IP whitelist / blacklist, CORS
• Built-in TLS / HTTPS support

Data & Templates

• In-memory sessions and key-value cache with TTL
• Multipart file uploads with save-to-disk
• MiniJinja templates (Jinja2-compatible)
• JSON parsing and encoding

Developer Experience

• Auto-generated OpenAPI docs at /docs
• Built-in brotli/gzip compression
• Request logging with configurable levels
• Homepage helper for instant landing pages

Utilities

• Hash — Argon2id, bcrypt, scrypt
• Crypto — AES-256-GCM, HMAC-SHA256
• Validate — Email, URL, IP, UUID, regex, JSON Schema
• Sanitize — HTML / XSS safe output
• Env — .env file loading
• DateTime — Formatting, parsing, arithmetic

---

📊 Benchmarks

Hello-world endpoint tested with wrk -t8 -c100 -d10s (5s warmup) on a Ryzen 9 7950x VM (12 vCPUs).

Framework	Language	Requests/sec	vs Bolt
Actix-web	Rust	785,403	2.3x faster
ASP.NET	.NET	529,987	1.5x faster
Fiber	Go	500,740	1.5x faster
Java Virtual Threads	Java	487,340	1.4x faster
Bolt	Ring/Rust	342,610	—
Gin	Go	296,610	1.2x slower
Bun	JS	153,550	2.2x slower
Elysia	Bun	152,201	2.3x slower
NestJS+Fastify/Node	JS	67,382	5.1x slower
Express/Bun	JS	58,397	5.9x slower
Flask	Python	48,851	7.0x slower
Express/Node	JS	39,571	8.7x slower
FastAPI	Python	2,153	159x slower

---

📦 Installation

ringpm install bolt from ysdragon

Requirements

• Ring 1.25+
• Pre-built binaries included for Windows, Linux (glibc / musl), macOS, and FreeBSD

---

🎯 Examples

#	Example	What it shows
01	hello	Basic routes, JSON, params
02	http_methods	All HTTP verbs
03	route_params	URL params, query strings, constraints
04	request_response	Headers, body, cookies
05	json_api	RESTful CRUD API
06	static_files	Serving directories

Browse the full set in examples/.

---

📚 Documentation

• Usage Guide — Feature-by-feature guide with complete code examples
• API Reference — Every method, every class, every parameter

---

⚙️ Common Configuration

new Bolt() {
    port = 3000
    host = "0.0.0.0"

    # Limits
    setBodyLimit(50 * 1024 * 1024)
    setTimeout(30000)
    setSessionCapacity(10000)
    setSessionTTL(300)
    setCacheCapacity(50000)
    setCacheTTL(600)

    # Security & features
    enableCors()
    enableCompression()
    enableLogging()
    enableDocs()
    homepage()

    # Routes...
}

---

🤝 Contributing

Issues and pull requests are welcome!

---

📄 License

MIT License — see LICENSE for details.