Skip to main content

Crate sova

Crate sova 

Source
Expand description

Sova — Express-like HTTP framework for Rust.

Thin facade over sova-core plus optional plugin crates. Prefer prelude in application main; plugin authors use extend.

Modules§

extend
Extension API (handlers, bodies, Bind, …) — see sova_core::extend.
extract
Typed request extractors (Path, Query, Json, State, …).
prelude
Everyday imports for application code.

Structs§

App
Application builder — thin wrapper over sova_core::App.
AppDispatch
Handle for dispatching requests inside the running app (DevTools console, tests).
BoundApp
Bound app — serve / run return facade Result.
Cell
Shared Clone value with change notifications (tokio::sync::watch under the hood).
CheckResult
Outcome of one named check from App::run_checks.
ClientAddr
Peer address stored on each request for rate-limiting etc.
ConfigDoc
Full parsed sova.toml (raw root for plugins; profile name for overlays).
DevToolsConfigRegistry
Plugins push JSON blobs here; DevTools merges them into GET /_devtools/config.
EventBus
Sync event bus: listeners run in the dispatching task (order of registration).
FormData
Parsed form body: text fields + file uploads (urlencoded or multipart).
Html
HTML body (text/html; charset=utf-8).
Json
JSON body (application/json).
LogConfig
Tracing install options (stdout and/or file).
MatchedRoute
Matched route path template (e.g. /users/:id), set after route match.
MatchedRouteCapture
Capture for root middleware: filled when a route matches (low-cardinality metrics).
NoContent
Empty 204 response.
OnUpgrade
Handle to finish an HTTP upgrade (e.g. WebSocket).
PluginMeta
Human-readable plugin metadata (CLI, docs, introspection).
PluginSdkVersion
Semantic version of the Plugin SDK (major.minor.patch).
RateLimitIdentity
Authenticated principal for rate-limit identity keys. Set by auth / passport when a user is hydrated; rate-limit falls back to IP if absent.
Redirect
HTTP redirect with explicit status.
Request
Incoming HTTP request with Express-style helpers.
RequestId
Per-request correlation id (inbound x-request-id or generated).
Response
Express-style HTTP response.
Router
Express-style router. Return from modules and app.mount("/blog", routes()).
Server
Compiled app ready to handle requests without recompiling the router.
Shutdown
Unified shutdown signal for BackgroundServices.
Slot
One-item ownership handoff between tasks (sockets, streams, anything non-Clone).
Static
Mount a directory behind Express-style routes (mount + mount/*path).
Text
Plain text (text/plain; charset=utf-8).
Upload
One uploaded file (or any multipart part with a filename).
UploadRules
Per-file constraints for Upload::validate.

Enums§

AppError
Unified handler / main error for apps that use the sova facade.
CheckKind
Kind of app check — readiness probes vs deploy-time audits.
Error
Framework and application errors mapped to HTTP responses.
ErrorFormat
Preferred error body format from an Accept header value.
Http
HTTP protocol mode for a bound app.
LogRotate
How to rotate the log file when LogConfig::file is set.

Constants§

PLUGIN_SDK_VERSION
Current Plugin SDK version (author-facing surface, not crate semver).

Traits§

BackgroundService
Long-running work started after on_startup, stopped after connection drain.
Event
Typed application event.
IntoResponse
Convert a value into an HTTP response.
Plugin
Single extension trait for the framework.

Functions§

current_accept
Accept header captured for the current request (if any).
ensure_request_id
Set RequestId from x-request-id or generate one (idempotent).
error_response_for_accept
Map Error using Accept (or current_accept when accept is None).
error_to_problem
Map a framework crate::Error to Problem Details (API preset).
html_error_page
Minimal HTML error document (no templates).
init_tracing
Install a default tracing subscriber (LogConfig::from_env).
logger
Paths registered via logger_skip_path / logger_skip_paths are not logged (useful for health checks and /_devtools/*).
logger_should_skip
Whether logger (and quiet crate::request_id spans) should skip this path.
logger_skip_path
Skip access-log lines for paths that equal or start with prefix (e.g. "/_devtools" matches /_devtools/config).
logger_skip_paths
Register several skip prefixes (see logger_skip_path).
negotiate_error_format
Pick a format: text/html wins over json/problem when both appear without clear exclusivity; application/problem+json / application/json → problem; else text.
problem_response
Build a Problem Details response.
problem_with_errors
Convenience for a field-error list (errors array).
referer_or
Referer header value, or fallback when absent/empty.
request_id
Ensure RequestId, echo x-request-id, wrap in an http.server span.
status_response_for_accept
Status-line response (router 404/405) negotiated from request Accept.
with_accept
Run fut with the request Accept header visible to current_accept.
with_state
Middleware with owned state — hides the Arc::clone dance.

Type Aliases§

Next
Call the rest of the middleware / handler chain.
Result
Facade result type (Result<T, AppError>).