caelix 0.0.23

Public Caelix framework crate.
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

#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]

//! Public Caelix framework crate.

/// Re-exported public API.
pub use caelix_core::*;
// Explicit re-exports so `test` / `main` are not pulled into `prelude` (which
// would shadow Rust's `#[test]`).
/// Re-exported public API.
pub use caelix_macros::{controller, gateway, guard, injectable, on_message};

/// OpenAPI generation types and controller documentation marker attributes.
#[cfg(feature = "openapi")]
/// Public Caelix module `openapi`.
pub mod openapi {
    /// Re-exported public API.
    pub use caelix_core::openapi::*;
    /// Re-exported public API.
    pub use caelix_macros::{errors, request_header, response, security};
}

/// RFC 6455 WebSocket gateway APIs.
///
/// The same types remain re-exported at the crate root for backwards
/// compatibility; prefer this namespace for new gateway code.
pub mod websocket {
    /// Re-exported public API.
    pub use caelix_core::{
        WebSocketCloseCode, WebSocketCloseFrame, WebSocketError, WebSocketGateway,
        WebSocketRequest, WebSocketSession,
    };
}

#[cfg(all(feature = "actix", feature = "axum"))]
compile_error!("Caelix backends `actix` and `axum` are mutually exclusive; select exactly one");

#[cfg(any(feature = "actix", feature = "axum"))]
/// Re-exported public API.
pub use caelix_macros::{main, test};

/// Hidden Actix re-export for macro-generated code. Prefer `caelix` public APIs
/// (`Application`, `TestApplication`, `#[caelix::main]`, `#[caelix::test]`).
#[cfg(feature = "actix")]
#[doc(hidden)]
pub use caelix_actix::__actix_web;

#[cfg(feature = "actix")]
/// Re-exported public API.
pub use caelix_actix::{
    Application, Logging, RequestPayload, TestApplication, TestApplicationBuilder,
    TestRequestBuilder, TestResponse, to_actix_response,
};

/// Hidden Axum and Tokio re-exports for generated controller and runtime code.
#[cfg(feature = "axum")]
#[doc(hidden)]
pub use caelix_axum::{__axum, __tokio};

#[cfg(feature = "axum")]
/// Re-exported public API.
pub use caelix_axum::{
    Application, AxumRequestInfo, AxumRouterBuilder, DEFAULT_BODY_LIMIT_BYTES, RequestPayload,
    TestApplication, TestApplicationBuilder, TestRequestBuilder, TestResponse, to_axum_response,
};

/// Socket.IO APIs, available only with the Axum-selecting `socketio` feature.
#[cfg(feature = "socketio")]
/// Public Caelix module `socket_io`.
pub mod socket_io {
    /// Re-exported public API.
    pub use caelix_socketio::*;
}

/// Public Caelix module `prelude`.
pub mod prelude {
    /// Re-exported public API.
    pub use caelix_core::*;
    /// Re-exported public API.
    pub use caelix_macros::{controller, gateway, guard, injectable, on_message};
}