Skip to content

API reference ​

The complete reference of types, traits, and functions is generated from the code with rustdoc. From the repository root:

bash
cargo doc -p corvis -p corvis-orm -p corvis-swagger --no-deps --open

The most useful entry points:

CrateModuleContents
corviscorvis::preludeWhat a typical application imports (use corvis::prelude::*;).
corviscorvis::diProvider, Token, DynamicModule, ModuleRef, ResolveCtx, Scope.
corviscorvis::httpRequest, Response, HttpException, and the built-in exceptions.
corviscorvis::zZod-style schemas and validation.
corviscorvis::testingTest, TestingModule, request.
corvis-ormcorvis_orm::preludeModels, queries, and OrmModule.
corvis-swaggerrootDocumentBuilder, SwaggerModule, #[api_*] attributes.

The attributes (#[module], #[injectable], #[controller], #[routes], #[handlers], #[websocket_gateway], #[derive(Validate)]) are documented in the corvis-macros crate and re-exported from corvis.

Released under the MIT License.