Expand description
Modules§
- extend
- Extension API (handlers, bodies,
Bind, …) — seesova_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).
- Bound
App - Bound app —
serve/runreturn facadeResult. - Cell
- Shared
Clonevalue with change notifications (tokio::sync::watchunder the hood). - Check
Result - Outcome of one named check from
App::run_checks. - Client
Addr - Peer address stored on each request for rate-limiting etc.
- Config
Doc - Full parsed
sova.toml(raw root for plugins; profile name for overlays). - DevTools
Config Registry - Plugins push JSON blobs here; DevTools merges them into
GET /_devtools/config. - Event
Bus - Sync event bus: listeners run in the dispatching task (order of registration).
- Form
Data - 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).
- Matched
Route - Matched route path template (e.g.
/users/:id), set after route match. - Matched
Route Capture - 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).
- Plugin
Meta - Human-readable plugin metadata (CLI, docs, introspection).
- Plugin
SdkVersion - Semantic version of the Plugin SDK (
major.minor.patch). - Rate
Limit Identity - 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.
- Request
Id - Per-request correlation id (inbound
x-request-idor 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).
- Upload
Rules - Per-file constraints for
Upload::validate.
Enums§
- AppError
- Unified handler /
mainerror for apps that use thesovafacade. - Check
Kind - Kind of app check — readiness probes vs deploy-time audits.
- Error
- Framework and application errors mapped to HTTP responses.
- Error
Format - Preferred error body format from an
Acceptheader value. - Http
- HTTP protocol mode for a bound app.
- LogRotate
- How to rotate the log file when
LogConfig::fileis set.
Constants§
- PLUGIN_
SDK_ VERSION - Current Plugin SDK version (author-facing surface, not crate semver).
Traits§
- Background
Service - Long-running work started after
on_startup, stopped after connection drain. - Event
- Typed application event.
- Into
Response - 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
RequestIdfromx-request-idor generate one (idempotent). - error_
response_ for_ accept - Map
ErrorusingAccept(orcurrent_acceptwhenacceptisNone). - error_
to_ problem - Map a framework
crate::Errorto Problem Details (API preset). - html_
error_ page - Minimal HTML error document (no templates).
- init_
tracing - Install a default
tracingsubscriber (LogConfig::from_env). - logger
- Paths registered via
logger_skip_path/logger_skip_pathsare not logged (useful for health checks and/_devtools/*). - logger_
should_ skip - Whether
logger(and quietcrate::request_idspans) 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/htmlwins 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 (
errorsarray). - referer_
or Refererheader value, orfallbackwhen absent/empty.- request_
id - Ensure
RequestId, echox-request-id, wrap in anhttp.serverspan. - status_
response_ for_ accept - Status-line response (router 404/405) negotiated from request Accept.
- with_
accept - Run
futwith the requestAcceptheader visible tocurrent_accept. - with_
state - Middleware with owned state — hides the
Arc::clonedance.