capy-framework 0.10.0

An opinionated full-stack Rust web framework with strong conventions and sensible defaults.
Documentation
//! An opinionated full-stack Rust web framework with strong conventions and sensible defaults.
//!
//! Capy integrates routing, validation, configuration, and database tooling with
//! a predictable application structure.
//!
//! Depend on this package as `capy = { package = "capy-framework", version = "0.10.0" }`.
//! The prelude contains the common API; named re-exports retain native escape hatches.

mod app;
#[cfg(feature = "mail")]
mod mail_commands;
#[cfg(feature = "mail")]
pub use capy_mail as mail;
#[cfg(feature = "mail")]
pub use capy_mail::notifications;
#[cfg(feature = "jobs")]
mod job_commands;
#[cfg(feature = "jobs")]
pub use capy_jobs as jobs;
#[cfg(feature = "scheduler")]
pub use capy_jobs::scheduler::{
    MissedRuns, OverlapPolicy, Schedule, Scheduler, Schedules, TaskContext, Tasks,
};
#[cfg(feature = "storage")]
pub use capy_storage as storage;
mod diagnostics;
mod frontend;
mod http_policy;
mod readiness;

pub use diagnostics::{RequestObservation, RequestObserver};
pub use readiness::{ready, ReadinessResponse};

pub use app::App;
#[cfg(feature = "auth")]
pub use capy_auth as auth;
pub use capy_core::{
    ApiErrorResponse, ApiSettings, AppConfig, AppContext, AppError, AppSettings, AuthSettings,
    AuthThrottleLimit, AuthThrottleSettings, ClientIpResolver, ClientIpSettings, ClientIpStrategy,
    Context, DatabaseSettings, Event, EventBus, EventContext, EventError, EventFuture,
    EventRejection, EventResult, Events, HashConcurrency, HttpSettings, JobsSettings, MailSettings,
    PasswordSettings, Result, SameSite, ServerSettings, Service, Services, SmtpSettings,
    ValidationErrors,
};
pub use capy_db as db;
pub use capy_db::{SeedContext, SeedFuture, Seeds};
pub use capy_http::{
    health, schema, ApiDocument, ApiRouteInfo, ApiSchema, Created, HealthResponse, Json, NoContent,
    Page, PageMeta, Paginated, Pagination, PaginationMeta, Path, Query, RouteInfo, Routes,
};
pub use capy_validation::Validated;

pub use axum;
pub use chrono;
pub use sea_orm;
pub use sea_orm_migration as migration;
pub use serde;
pub use serde_json;
pub use tokio;
pub use tower;
pub use tower_http;
pub use tracing;
pub use uuid;
pub use validator;

#[cfg(feature = "testing")]
pub use capy_testing as testing;

/// The small set of types most API handlers need.
pub mod prelude {
    pub use crate::{
        ApiSchema, App, AppConfig, AppContext, AppError, Context, Created, Event, EventBus,
        EventError, EventRejection, EventResult, Json, NoContent, Page, Paginated, Pagination,
        Path, Query, Result, Routes, Service, Services, Validated,
    };
    #[cfg(feature = "jobs")]
    pub use capy_jobs::{JobDispatch, TransactionalJobDispatch};
    #[cfg(feature = "mail")]
    pub use capy_mail::{MailContext, Mailable};
    #[cfg(feature = "storage")]
    pub use capy_storage::{Storage, StorageKey};
    pub use sea_orm::DatabaseConnection;
    pub use serde::{Deserialize, Serialize};
    pub use serde_json::{json, Value};
    pub use validator::Validate;
}

mod dev_logging;