Skip to main content

capy_framework/
lib.rs

1//! An opinionated full-stack Rust web framework with strong conventions and sensible defaults.
2//!
3//! Capy integrates routing, validation, configuration, and database tooling with
4//! a predictable application structure.
5//!
6//! Depend on this package as `capy = { package = "capy-framework", version = "0.6.0" }`.
7//! The prelude contains the common API; named re-exports retain native escape hatches.
8
9mod app;
10#[cfg(feature = "mail")]
11mod mail_commands;
12#[cfg(feature = "mail")]
13pub use capy_mail as mail;
14#[cfg(feature = "mail")]
15pub use capy_mail::notifications;
16#[cfg(feature = "jobs")]
17mod job_commands;
18#[cfg(feature = "jobs")]
19pub use capy_jobs as jobs;
20mod diagnostics;
21mod frontend;
22mod http_policy;
23mod readiness;
24
25pub use diagnostics::{RequestObservation, RequestObserver};
26pub use readiness::{ready, ReadinessResponse};
27
28pub use app::App;
29#[cfg(feature = "auth")]
30pub use capy_auth as auth;
31pub use capy_core::{
32    ApiErrorResponse, ApiSettings, AppConfig, AppContext, AppError, AppSettings, AuthSettings,
33    ClientIpResolver, ClientIpSettings, ClientIpStrategy, Context, DatabaseSettings, Event,
34    EventBus, EventContext, EventFuture, Events, HashConcurrency, HttpSettings, JobsSettings,
35    MailSettings, PasswordSettings, Result, SameSite, ServerSettings, SmtpSettings,
36    ValidationErrors,
37};
38pub use capy_db as db;
39pub use capy_http::{
40    health, schema, ApiDocument, ApiRouteInfo, ApiSchema, Created, HealthResponse, Json, NoContent,
41    Page, PageMeta, Paginated, Pagination, PaginationMeta, Path, Query, RouteInfo, Routes,
42};
43pub use capy_validation::Validated;
44
45pub use axum;
46pub use chrono;
47pub use sea_orm;
48pub use sea_orm_migration as migration;
49pub use serde;
50pub use serde_json;
51pub use tokio;
52pub use tower;
53pub use tower_http;
54pub use tracing;
55pub use validator;
56
57#[cfg(feature = "testing")]
58pub use capy_testing as testing;
59
60/// The small set of types most API handlers need.
61pub mod prelude {
62    pub use crate::{
63        ApiSchema, App, AppConfig, AppContext, AppError, Context, Created, Event, EventBus, Json,
64        NoContent, Page, Paginated, Pagination, Path, Query, Result, Routes, Validated,
65    };
66    #[cfg(feature = "jobs")]
67    pub use capy_jobs::JobDispatch;
68    #[cfg(feature = "mail")]
69    pub use capy_mail::{MailContext, Mailable};
70    pub use sea_orm::DatabaseConnection;
71    pub use serde::{Deserialize, Serialize};
72    pub use serde_json::{json, Value};
73    pub use validator::Validate;
74}
75
76mod dev_logging;