ironic 0.1.0

A batteries-included, type-safe application framework for Rust
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

#![doc = "Ironic is a batteries-included, type-safe application framework for Rust."]

// Keep the source modules independent internally while presenting one public crate.
// These aliases also keep generated and hand-written framework internals on stable paths.
extern crate self as rustframe_core;
extern crate self as rustframe_di;
extern crate self as rustframe_http;
extern crate self as rustframe_platform;
extern crate self as rustframe_platform_axum;

#[path = "../crates/ironic-cli/src/lib.rs"]
mod cli_impl;
#[path = "../crates/ironic-common/src/lib.rs"]
mod common;
#[path = "../crates/ironic-config/src/lib.rs"]
mod config_impl;
#[path = "../crates/ironic-core/src/lib.rs"]
mod core;
#[path = "../crates/ironic-di/src/lib.rs"]
mod di;
#[path = "../crates/ironic-http/src/lib.rs"]
mod http_impl;
#[path = "../crates/ironic-openapi/src/lib.rs"]
mod openapi;
#[path = "../crates/ironic-platform/src/lib.rs"]
mod platform;
#[path = "../crates/ironic-platform-axum/src/lib.rs"]
mod platform_axum;
#[path = "../crates/ironic-testing/src/lib.rs"]
mod testing;

pub use cli_impl::{CliError, cli, generators, run, run_with};
pub use common::*;
pub use config_impl::*;
pub use core::*;
pub use di::*;
pub use http_impl::*;
pub use ironic_macros::{
    Injectable, Module, OpenApiSchema, body, controller, delete, get, head, header, main, options,
    param, patch, post, put, query, routes, use_guard, use_interceptor,
};
pub use openapi::*;
pub use platform::*;
pub use platform_axum::*;
pub use testing::*;

/// Implementation details used by generated code.
#[doc(hidden)]
pub mod __private {
    use std::future::Future;

    pub use serde_json;

    /// Runs the future produced by a macro-generated application entry point.
    pub fn block_on<F: Future>(future: F) -> F::Output {
        tokio::runtime::Builder::new_multi_thread()
            .enable_all()
            .build()
            .expect("Ironic failed to initialize its Tokio runtime")
            .block_on(future)
    }
}

/// Commonly used Ironic types and macros.
pub mod prelude {
    pub use crate::{
        ConfigurationError, ConfigurationLoader, ControllerDefinition, Dependency,
        FrameworkApplication, FrameworkError, FrameworkResult, Guard, GuardDecision, GuardFuture,
        HeaderParameter, HealthModule, HealthStatus, HttpError, HttpMethod, HttpPlatformAdapter,
        HttpPlatformApplication, Injectable, Interceptor, InterceptorNext, Json, JsonBody,
        LifecycleDefinition, Middleware, Module, ModuleDefinition, OnApplicationBootstrap,
        OnApplicationShutdown, OnModuleDestroy, OnModuleInit, OpenApiSchema, ParameterPipe,
        PathParameter, PipelineFuture, ProviderDefinition, QueryParameters, RequestContext,
        RequestId, RequestTracing, RouteDefinition, RouteMetadata, Scope, Secret, SecretString,
        ShutdownSignal, ValidateConfiguration, body, controller, delete, get, handler_fn, head,
        header, options, param, patch, pipe_fn, post, put, query, routes, use_guard,
        use_interceptor,
    };
}