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.10.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;
20#[cfg(feature = "scheduler")]
21pub use capy_jobs::scheduler::{
22    MissedRuns, OverlapPolicy, Schedule, Scheduler, Schedules, TaskContext, Tasks,
23};
24#[cfg(feature = "storage")]
25pub use capy_storage as storage;
26mod diagnostics;
27mod frontend;
28mod http_policy;
29mod readiness;
30
31pub use diagnostics::{RequestObservation, RequestObserver};
32pub use readiness::{ready, ReadinessResponse};
33
34pub use app::App;
35#[cfg(feature = "auth")]
36pub use capy_auth as auth;
37pub use capy_core::{
38    ApiErrorResponse, ApiSettings, AppConfig, AppContext, AppError, AppSettings, AuthSettings,
39    AuthThrottleLimit, AuthThrottleSettings, ClientIpResolver, ClientIpSettings, ClientIpStrategy,
40    Context, DatabaseSettings, Event, EventBus, EventContext, EventError, EventFuture,
41    EventRejection, EventResult, Events, HashConcurrency, HttpSettings, JobsSettings, MailSettings,
42    PasswordSettings, Result, SameSite, ServerSettings, Service, Services, SmtpSettings,
43    ValidationErrors,
44};
45pub use capy_db as db;
46pub use capy_db::{SeedContext, SeedFuture, Seeds};
47pub use capy_http::{
48    health, schema, ApiDocument, ApiRouteInfo, ApiSchema, Created, HealthResponse, Json, NoContent,
49    Page, PageMeta, Paginated, Pagination, PaginationMeta, Path, Query, RouteInfo, Routes,
50};
51pub use capy_validation::Validated;
52
53pub use axum;
54pub use chrono;
55pub use sea_orm;
56pub use sea_orm_migration as migration;
57pub use serde;
58pub use serde_json;
59pub use tokio;
60pub use tower;
61pub use tower_http;
62pub use tracing;
63pub use uuid;
64pub use validator;
65
66#[cfg(feature = "testing")]
67pub use capy_testing as testing;
68
69/// The small set of types most API handlers need.
70pub mod prelude {
71    pub use crate::{
72        ApiSchema, App, AppConfig, AppContext, AppError, Context, Created, Event, EventBus,
73        EventError, EventRejection, EventResult, Json, NoContent, Page, Paginated, Pagination,
74        Path, Query, Result, Routes, Service, Services, Validated,
75    };
76    #[cfg(feature = "jobs")]
77    pub use capy_jobs::{JobDispatch, TransactionalJobDispatch};
78    #[cfg(feature = "mail")]
79    pub use capy_mail::{MailContext, Mailable};
80    #[cfg(feature = "storage")]
81    pub use capy_storage::{Storage, StorageKey};
82    pub use sea_orm::DatabaseConnection;
83    pub use serde::{Deserialize, Serialize};
84    pub use serde_json::{json, Value};
85    pub use validator::Validate;
86}
87
88mod dev_logging;