Skip to main content

API reference

Version stamp

Applies to: renvor 0.0.0 · framework source 7d0816a · MSRV 1.94.0 · documentation set pre-release

This stamp is a single shared partial (docs/_stamp.mdx) imported by every prose page and the API reference. It binds this documentation snapshot to the immutable framework commit it describes. The framework remains unpublished and no release compatibility promise applies.

Generated reference

The API reference is generated by rustdoc from the crate source, not written by hand.

  • After publication: docs.rs/renvor
  • From this source tree: cargo doc --workspace --all-features --no-deps --open

The crate is not published today, so the docs.rs page is only the destination for a future release. Repository verification builds rustdoc with warnings denied; broken intra-doc links fail the build.

The facade is intentionally smaller than the workspace

renvor 0.0.0 re-exports the transport-independent kernel and, through features, configuration and the REST/HTTP surface. The workspace also contains persistence and authentication crates, but the facade does not expose them yet.

SurfaceWorkspace implementationReachable through renvor
Kernel lifecycle and providersrenvor-coreYes
Layered configurationrenvor-configYes, default feature
REST and HTTP deliveryrenvor-httpYes, off-by-default feature
Validation and OpenAPIrenvor-validationThrough the HTTP feature
Persistence portsrenvor-databaseNo
SQLx and SeaORM adaptersrenvor-sqlx, renvor-seaormNo
Authentication domain and HTTP adapterrenvor-auth, renvor-auth-httpNo

This table is a warning against reading “implemented in the workspace” as “supported by the facade.” That distinction remains until an explicit integration phase changes the dependency graph.

Identity constants

ItemTypeValue
renvor::VERSION&strWorkspace package version
renvor::MSRV&str"1.94.0"
renvor::EXECUTABLE&str"renvor"
assert_eq!(renvor::MSRV, "1.94.0");
assert_eq!(renvor::EXECUTABLE, "renvor");

Stability

Every public API remains explicitly unstable. A real transport has exercised part of the surface, but no accepted decision has closed the second condition in the framework's API-stability contract. The instability window is still open.

The authoritative sources are the generated rustdoc and the framework's API-stability contract.