Expand description
Shared Rust service foundation for application backends.
footing is intentionally small and feature-gated. It collects reusable
infrastructure concerns such as principal authorization, password storage,
pagination, HTTP request context, RFC 9457 problem responses, database pool
configuration, and tracing setup without depending on an application’s domain
model.
§Feature layout
No features are enabled by default. Enable only the capabilities needed by your application; feature dependencies are enabled automatically.
For example, http-stack already includes http and http-metrics;
password-tokio includes password and auth. Features make APIs available;
applications explicitly install middleware, start workers, and initialize logs.
§HTTP
| Feature | Capability and automatically enabled features |
|---|---|
http | Axum request context, trusted proxies, safe extractors, problem responses, security headers, and endpoint contracts; enables auth and net. |
http-metrics | Independent HTTP metrics, optional response-body observations, and Prometheus/OpenMetrics responses; enables http and observability. |
http-stack | Middleware assembly, CORS, timeouts, concurrency, rate limiting, idempotency, metrics, and health responses; enables http-metrics, pagination, and settings. |
http-cookie | Validated cookie policies, credential reads, and issuance/removal; enables http, settings, and secrets. |
http-locale | Explicit language negotiation and response headers; enables http. |
http-static | Filesystem-backed static sites and SPA fallback; enables http. |
http-client | Reqx TLS trust integration; enables tls, independently of http. Applications declare Reqx and explicitly select its TLS backend. |
pagination | Cursor and offset pagination; HTTP extractors are available with http. |
openapi | Schemas, documented routes, and documentation pages; enables http. Renderer and asset source are selected explicitly. |
redoc-embedded, rapidoc-embedded | Bundled documentation assets; each enables openapi. |
§Authentication and cryptography
| Feature | Capability and automatically enabled features |
|---|---|
auth | Principals, roles, scopes, permission guards, and explicit new-password admission checks; no password hashing or async runtime. |
password | Argon2id password storage and verification; enables auth. Admission rules remain an explicit, separate call. |
password-common | Bundled common-password list for explicit use by PasswordPolicy; enables auth, without Argon2 or Tokio. |
password-tokio | Bounded Tokio scheduling for password work; enables password and secrets. |
crypto | Secure tokens and cryptographic helpers; enables secrets. |
§Storage
| Feature | Capability and automatically enabled features |
|---|---|
postgres | SQLx PostgreSQL pools and startup helpers; enables settings and secrets. |
postgres-admin | Destructive PostgreSQL administration; enables postgres. |
sqlite | SQLx SQLite pools and startup helpers; enables settings. |
presence-postgres | Shared heartbeat-based online user queries; enables postgres and time. |
presence-sqlite | Online user queries in a local SQLite database; enables sqlite and time. |
§Runtime and observability
| Feature | Capability and automatically enabled features |
|---|---|
runtime | Ordered application lifecycle orchestration. |
worker | Background workers, leases, and outbox primitives; enables settings and observability. |
event | In-process domain event dispatch and hooks. |
diagnostics | Startup resource probes and readiness diagnostics. |
observability | Metrics, health reports, structured event values, and trace identifiers; no log subscriber or timestamp formatter. |
logging | Log formatting, filters, and explicit subscriber initialization in footing::logging; independent of observability. |
testkit | Fixtures and test assertions; enables http and worker. Intended for development dependencies. |
§Shared primitives and integrations
| Feature | Capability |
|---|---|
serde | Serialization support for the always-available result types. Enabled by higher-level capabilities as needed. |
settings | Human-readable durations and component settings validation. |
tier | Tier configuration metadata and validation adapters; enables settings. |
time | UTC wall-clock abstractions using the time crate. |
net | IP network parsing and matching. |
secrets | Redacted secret values and secret sources. |
tls | TLS trust configuration and certificate loading, independently of HTTP clients and crypto providers. |
§Examples
Principal checks:
use footing::auth::{Principal, PrincipalRequirement};
let principal = Principal::user("usr_01")
.unwrap()
.with_scopes(["users:*"])
.unwrap();
PrincipalRequirement::scope("users:read")
.unwrap()
.check(&principal)
.unwrap();Password hashing:
use footing::auth::PasswordService;
let service = PasswordService::new();
let hash = service.hash_password("correct horse battery staple").unwrap();
let verification = service
.verify_and_assess("correct horse battery staple", &hash)
.unwrap();
assert!(verification.verified());
assert!(!verification.needs_rehash());Modules§
- auth
auth - Authentication and authorization primitives.
- clock
- Clock abstraction for runtime code and deterministic tests.
- crypto
crypto - Small cryptographic building blocks for application glue code.
- db
postgresorsqlite - SQLx database integrations separated by backend-specific semantics.
- diagnostics
diagnostics - Startup and readiness diagnostics for service resources.
- event
event - In-process domain event dispatch.
- http
http - HTTP helpers for Axum services.
- logging
logging - Application-owned log formatting, filtering, and subscriber initialization.
- net
net - Network primitives shared by service configuration and transports.
- observability
observability - Structured event values, trace identifiers, health reporting, and metrics.
- pagination
pagination - Pagination primitives for service APIs.
- presence
presence-postgresorpresence-sqlite - Shared online user queries based on recent authenticated heartbeats.
- result
- Lightweight result aliases and stable error classification.
- runtime
runtime - Explicit application lifecycle orchestration.
- secret
secrets - Secret and redaction primitives.
- settings
settings - Settings primitives shared by Footing components.
- testkit
testkit - Fixtures, HTTP helpers, and collection assertions for tests.
- tls
tls - Outbound TLS trust configuration.
- worker
worker - Small worker runtime primitives.
Macros§
- openapi_
route httpandopenapi - Collects a handler’s route and schemas from its
utoipa::pathannotation.