Skip to main content

Crate rullst

Crate rullst 

Source

Re-exports§

pub use rullst_orm as orm;
pub use rullst_orm;

Modules§

artisan
Artisan command-line migrations and seed execution helpers. Database Artisan CLI execution and developer Studio dashboard server.
async_runtime
Re-exported underlying asynchronous engine (Tokio).
cache
Rullst Cache System (rullst::cache)
client
Edge client components rendering module.
client_contract
Portable, versioned wire contract shared by web and platform clients. Bounded, versioned JSON envelopes for Rullst web and platform clients.
config
Rullst application and server configuration models.
db
devops
Agentic DevOps Engine & Infrastructure Tuning (Milestone 20).
di
Type-indexed dependency injection container. Type-indexed dependency injection container (rullst::di).
edge
Rullst Edge Runtime (rullst::edge)
error_console
HTML visual logging and runtime console for development mode. Interactive dev error console with source context inspection and AI assistance.
feature
Feature flagging management and drivers. Feature flags system for rullst-core.
frontend
Hybrid Frontend SSR Adapters (Leptos, Dioxus, HTMX). Modular Frontend Engines & SSR Adapters for Rullst.
health
Kubernetes and Cloud-Native Health Probes. Kubernetes and Cloud-Native Health Probes (Liveness & Readiness)
html
Fast compile-time HTML rendering utilities.
htmx
HTMX helpers for rapid reactive UI design.
lifecycle
Process readiness and graceful request-drain coordination. Bounded process lifecycle, readiness, and graceful request draining.
live
Live state synchronization and server-push connection handlers.
multitenant
Multitenancy request routing and tenant state isolation layers.
production
Canonical production middleware ordering contract. Canonical production middleware ordering contract.
queue
Rullst Queue System (rullst::queue)
radar
Rullst Radar Kernel-Level Telemetry & Tokio runtime visualizer. Rullst Radar — process telemetry and Tokio runtime observations (rullst::radar).
realtime
Native Real-Time Engine (Channels, Broadcast, Presence). Native Real-Time Engine (Channels, Broadcast, Presence).
resilience
Network and service resilience (rate limits, traffic shield, load shedding).
response
Standard HTTP response types and helpers.
routing
High-performance application routers built on Axum.
rpc
Typed, versioned browser-to-server function transport. Versioned transport primitives for #[server_function].
runtime
Internal asynchronous runtime wrappers.
scalar
Interactive Scalar API documentation UI. Interactive Scalar API Documentation Page (/docs)
scheduler
Rullst Task Scheduler (rullst::scheduler)
security
Security facade for the lightweight Core middleware and, when the security feature is enabled, the extended rullst-security suite.
server
Rullst HTTP web server core engine. Application server bootstrap, hot-reloader, and Tower middleware integration.
storage
File and cloud storage abstraction layer. Unified Object Storage & Media Pipeline for Rullst applications.
telemetry
Rullst OpenTelemetry and Tracing.
telemetry_spans
Distributed Tracing Spans Collector. Distributed Tracing Telemetry & Flamegraph Collector.
testing
Scaffolding tools for robust integration testing.
uploads
Server-side upload admission and quarantine contracts.
validation
Strongly-typed request validation extractors.
web
Web server engine re-exports (Axum, Tower, Tower-HTTP).
ws
WebSocket live connection and messaging system.

Macros§

artisan
Standard migration and seeding bootstrap macro for Rullst.
html
A macro for writing HTML inline in Rust. It compiles down to highly optimized string concatenations at compile time, and automatically escapes dynamic variables to prevent XSS.
routes
Declarative macro for building a Router from a list of HTTP route definitions.

Structs§

AcademyBoundaryAssessment
One normalized Academy boundary assessment.
AcademyProductionPreset
Fail-closed Academy domain assessment layered on the canonical production order.
AppConfig
General configuration options for the application instance.
ApplicationLifecycle
Shared process-local readiness and graceful-drain coordinator.
BroadcastManager
Thread-safe in-memory pub/sub manager for realtime channels.
Cache
The main cache facade for storing and retrieving cached values.
Channel
Represents a named realtime channel with broadcast capabilities.
Container
Thread-safe Dependency Injection Container.
DatabaseConfig
Database connection configuration.
DbFeatureDriver
Feature flag driver backed by a database table rullst_feature_flags.
EnvFeatureDriver
Driver that parses feature flags defined in environment variables.
FeatureManager
The primary feature flags manager coordinating the driver pipeline.
HtmxRequest
Extract’s HTMX request headers to determine context and re-act re-actively.
HtmxResponse
A highly ergonomic, builder-style HTMX responder to set dynamic headers in client side.
Inject
Axum extractor for dependencies managed by Rullst DI Container.
LocalDriver
Local disk storage driver supporting path traversal protection
MemoryFeatureDriver
Memory-backed feature flag driver. Perfect for programmatic overrides and tests.
OfflineMockScanner
Deterministic offline scanner for tests and local development only.
Orm
Orm configuration structure
ProductionPreset
Typed, stable description of the v12 production middleware preset.
QuarantinedUpload
Metadata for an admitted object that must remain quarantined until scanned.
Queue
The main queue facade for dispatching background jobs.
QueuedJobDetail
Detailed job information, used for dashboard monitoring
RateLimitConfig
Extensible configuration for the Token-Bucket Rate Limiter.
RateLimiter
Thread-safe Token-Bucket rate limiter powered by Shared-Memory DashMap.
ReadinessSnapshot
Bounded readiness counters safe for public orchestration probes.
RealtimeMessage
Payload model for realtime broadcast events.
ReleasedUpload
Metadata safe to persist after a clean scan.
Router
A wrapper around Axum’s Router to provide clean integration with Rullst features
RullstConfig
Main configuration container for Rullst applications.
Scheduler
A declarative scheduler for recurring asynchronous jobs.
SchedulerHandle
Owns running scheduler loops and exposes their typed failures.
SecurityConfig
Configuration options for application security layers.
Server
The central application server builder for Rullst.
Storage
Unified Storage Engine Client
TenantCache
Cache facade permanently bound to one authenticated tenant context.
TenantConfig
Configuration settings for multitenancy extraction.
TenantLayer
The declarative custom Tower Layer for tenant identification
TenantPresence
In-process presence facade permanently bound to one authenticated tenant.
TenantRealtime
In-process realtime facade permanently bound to one authenticated tenant.
TenantService
The declarative custom Tower Service for tenant identification
TenantStorage
Storage facade permanently bound to one authenticated tenant context.
TestApp
A fluent testing wrapper around Axum’s Router to enable declarative E2E assertions.
TestRequestBuilder
A request builder for constructing HTTP requests in tests. Implements IntoFuture so it can be .awaited directly to send the request.
TestResponse
A wrapper around Axum’s Response that provides fluent assertion methods.
TomlFeatureDriver
Driver that parses feature flags defined in Rullst.toml.
TrafficShield
The core resilience monitor that performs real-time diagnostics on Tokio latency and Database roundtrip speeds.
TrafficShieldConfig
Configures the limits and behavior of the Adaptive Backpressure & Resilient Traffic Shielding.
UploadPolicy
Immutable upload admission policy.
ValidatedForm
Extractor for validating form payloads
ValidatedJson
Extractor for validating JSON payloads
WebSocket
A high-level, elegant wrapper for Axum WebSockets, built for premium DX and HTMX
Worker
Polls a queue and executes registered handlers with bounded concurrency.
WorkerHandle
Owns a running queue worker and exposes asynchronous processing failures.

Enums§

AcademyCheckStatus
Evidence status for one Academy production boundary.
AcademyPresetError
Fail-closed Academy preset validation error.
AcademyProductionRequirement
An Academy domain boundary that must be evaluated by the deployed application.
ApplicationLifecycleError
Typed lifecycle construction, transition, and drain failures.
ApplicationPhase
Monotonic phase of one Rullst application process.
DiError
Strongly-typed error domain for Rullst Dependency Injection.
ProductionMiddlewareStage
A stage in the canonical inbound production middleware chain.
RealtimeError
Strongly-typed error domain for Rullst Realtime and Broadcast operations.
ScanVerdict
Scanner outcome. Unavailable is always fail-closed.
SchedulerError
Strongly-typed error domain for scheduler operations.
SchedulerFailurePolicy
Action taken after a timeout, panic, or unexpected cancellation.
SecurityBaselineError
Failure to construct the runtime security baseline from application configuration.
ServerError
Typed server startup and runtime failures.
StorageDriver
Storage Driver Target Adapter
StorageError
Strongly-typed error domain for Rullst Storage operations.
TenantStrategy
Strategy used to extract the active tenant ID from an incoming request.
TrafficShieldError
Failures that can occur while managing Traffic Shield monitors.
UploadError
Upload validation and scan failures.
UploadKind
Bounded content families recognized by the built-in signature gate.
ValidationError
Error type returned by ValidatedForm and ValidatedJson extractors. Automatically renders HTMX-friendly HTML error components for HTMX requests, or standard JSON 422/400 responses for REST clients.
WsError
Error type for Rullst WebSocket operations.

Traits§

FeatureDriver
Abstraction over feature flag and A/B split configurations.
Injectable
Trait implemented by types that can be automatically injected by Rullst DI.
RullstModel
The core trait that all Orm models will implement via #[derive(Orm)]
UploadScanner
Static-dispatch scanner adapter contract.
Validate
This is the original trait that was implemented by deriving Validate. It will still be implemented for struct validations that don’t take custom arguments. The call is being forwarded to the ValidateArgs<'v_a> trait.

Functions§

apply_lifecycle
Applies lifecycle admission to application routes.
apply_security_baseline
Applies the canonical runtime-owned browser security baseline.
backpressure_middleware
Router-level protection middleware that tracks load timing and drops requests under critical saturation.
rate_limit_middleware
Native Axum middleware enforcing rate limiting.
render_page
Helper function to render a hybrid SSR layout page.
tenant_layer
Fluent helper to return a Tower Middleware Layer using TenantConfig

Attribute Macros§

async_trait
island
Proc macro attribute to define a Wasm Island client component.
live_component
Proc macro attribute to define a Live Component. Automatically implements the LiveComponent trait and wires #[live_event] methods.
live_event
Marker attribute for events handled by a Live Component.
memoize
A macro for intelligent caching of component renders or database queries. It wraps a function, caching the returned output based on the function’s arguments. If the function is called again with the same arguments, it returns the cached HTML immediately.
require_role
route
Legacy compatibility marker that preserves the annotated function unchanged.
server_function
Defines a bounded, dual-target Rullst server function.

Derive Macros§

Billable
Orm
Validate