jerrycan 0.3.0

The AI-native Rust backend platform: framework, CLI, and MCP server. https://jerrycan.cc
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

//! The AI-native Rust backend platform. Generated apps depend on this one
//! crate (plus tokio) and write `use jerrycan::prelude::*;`.
//! The CLI/MCP binary joins this package in Phase 1 behind a `cli` feature.
#![forbid(unsafe_code)]

/// `#[macro_export]` lands `path_param!` at the `jerrycan_core` crate root; this
/// re-export makes `jerrycan::path_param!` resolve through the facade.
pub use jerrycan_core::path_param;
pub use jerrycan_core::*;
pub use jerrycan_macros::main;

#[cfg(feature = "db")]
pub use jerrycan_db as db;

#[cfg(feature = "validate")]
pub use jerrycan_validate as validate;

#[cfg(feature = "auth")]
pub use jerrycan_auth as auth;

#[cfg(feature = "rate-limit")]
pub use jerrycan_ratelimit as ratelimit;

#[cfg(feature = "observe")]
pub use jerrycan_observe as observe;

#[cfg(feature = "jobs")]
pub use jerrycan_jobs as jobs;

#[cfg(feature = "storage")]
pub use jerrycan_storage as storage;

#[cfg(feature = "realtime")]
pub use jerrycan_realtime as realtime;

#[cfg(feature = "cli")]
pub mod platform;

pub mod prelude {
    pub use jerrycan_core::prelude::*;
    pub use jerrycan_macros::main;
}

/// Compile-checks every example in docs/ai/*.md (spec §8: executable docs).
#[cfg(doctest)]
mod doc_tests {
    macro_rules! doc_page {
        ($name:ident, $path:literal) => {
            #[doc = include_str!($path)]
            mod $name {}
        };
    }
    doc_page!(page_00_designing, "../../../docs/ai/00-designing.md");
    doc_page!(page_01_app, "../../../docs/ai/01-app.md");
    doc_page!(page_02_modules, "../../../docs/ai/02-modules.md");
    doc_page!(page_03_extractors, "../../../docs/ai/03-extractors.md");
    doc_page!(page_04_dependencies, "../../../docs/ai/04-dependencies.md");
    doc_page!(page_05_errors, "../../../docs/ai/05-errors.md");
    doc_page!(page_06_middleware, "../../../docs/ai/06-middleware.md");
    doc_page!(page_07_testing, "../../../docs/ai/07-testing.md");
    #[cfg(feature = "db")]
    doc_page!(page_08_database, "../../../docs/ai/08-database.md");
    #[cfg(feature = "validate")]
    doc_page!(page_09_validation, "../../../docs/ai/09-validation.md");
    #[cfg(feature = "auth")]
    doc_page!(page_10_auth, "../../../docs/ai/10-auth.md");
    #[cfg(feature = "observe")]
    doc_page!(
        page_11_observability,
        "../../../docs/ai/11-observability.md"
    );
    doc_page!(page_12_packaging, "../../../docs/ai/12-packaging.md");
    #[cfg(all(feature = "db", feature = "auth"))]
    doc_page!(page_14_tenancy, "../../../docs/ai/14-tenancy.md");
    #[cfg(feature = "jobs")]
    doc_page!(page_15_jobs, "../../../docs/ai/15-jobs.md");
    // Page 16 demonstrates the `MockIdp` harness, which is test/eval-only and lives
    // behind the non-default `mock-idp` feature (kept off plain `oauth` so it can't
    // reach a prod build). The page's runnable mock snippet only compiles when that
    // feature is on, so the whole page is gated on it; run it with
    // `cargo test -p jerrycan --features mock-idp --doc`.
    #[cfg(feature = "mock-idp")]
    doc_page!(
        page_16_auth_advanced,
        "../../../docs/ai/16-auth-advanced.md"
    );
    // Page 17 uses only default-facade response types (Json/Created/NoContent/
    // Redirect/StatusCode/the (StatusCode, body) tuple), so it needs no feature.
    doc_page!(
        page_17_response_types,
        "../../../docs/ai/17-response-types.md"
    );
    // Storage examples resolve jerrycan::storage + db, so the page is gated on
    // the storage feature; run with `cargo test -p jerrycan --features storage --doc`.
    #[cfg(feature = "storage")]
    doc_page!(page_18_storage, "../../../docs/ai/18-storage.md");
    // Realtime examples resolve jerrycan::realtime + db, so the page is gated on
    // the realtime feature; run with `cargo test -p jerrycan --features realtime,auth --doc`.
    #[cfg(all(feature = "realtime", feature = "auth"))]
    doc_page!(page_18_realtime, "../../../docs/ai/18-realtime.md");
}

/// The realtime facade surface: `jerrycan::realtime::{Realtime, Principal,
/// TopicScope, ChangeChannelSpec}` must resolve when the feature is on —
/// generated wiring (realtimegen) is compiled against exactly these paths.
#[cfg(all(test, feature = "realtime"))]
mod realtime_facade {
    #[test]
    fn facade_paths_resolve() {
        fn _typecheck(rt: crate::realtime::Realtime) -> crate::realtime::Realtime {
            rt.broadcast("room", crate::realtime::TopicScope::Tenant)
        }
    }
}