webx/
lib.rs

1//! Umbrella crate for the rust-webx framework (package `rust-webx`, imported as
2//! `webx`).
3//!
4//! Re-exports the whole framework so applications need a single dependency:
5//!
6//! ```toml
7//! [dependencies]
8//! rust-webx = "0.8"
9//! ```
10//!
11//! ```ignore
12//! use webx::*;
13//! ```
14//!
15//! The dependency name is `rust-webx`; the import name is `webx`. The same
16//! applies to the sub-crates (`rust-webx-core` → `webx_core`,
17//! `rust-webx-host` → `webx_host`, `rust-webx-macros` → `webx_macros`,
18//! `rust-webx-spa` → `webx_spa`, `rust-webx-openapi` → `webx_openapi`).
19
20// --- Core traits ---
21pub use webx_core::app::IHost;
22pub use webx_core::auth::{
23    IAuthenticationHandler, IAuthorizationPolicy, IClaims, IDynamicAuthorizer, IdentityUser,
24    RequestUser,
25};
26pub use webx_core::cache::{
27    cache_ext::DistributedCacheExtensions,
28    options::DistributedCacheEntryOptions,
29    trait_def::{CacheError, IDistributedCache},
30};
31pub use webx_core::config::{
32    bind_config, bind_root, load_appsettings, AppOptions, AppSection, CorsSection, CultureSection,
33    IAppOptions, JwtSection, MetricsSection, RateLimitSection, TlsSection,
34};
35pub use webx_core::dispatch_runtime::DispatchRuntime;
36pub use webx_core::error::{Error, Result};
37pub use webx_core::form::{
38    sanitize_file_name, set_spool_root, spool_root, FormField, FormFile, FormFileBuilder,
39    MultipartForm, SPOOL_FILE_PREFIX,
40};
41pub use webx_core::handler::{IEventHandler, IHostedService, IRequestHandler};
42pub use webx_core::http::{
43    content_disposition_value, read_json_body, write_json_response, ByteRange, Disposition,
44    FileBody, FileSource, HttpStatus, IClaimsExt, IHttpContext, IHttpRequest, IHttpResponse, Json,
45    ResponseBody, SeekableReader, STREAM_BUF_SIZE,
46};
47pub use webx_core::localization::{
48    IStringLocalizer, LocalizationOptions, LocalizedString, StringLocalizer, TextRef,
49};
50pub use webx_core::mediator::dispatch;
51pub use webx_core::mediator::{IEventRequest, IMediator, IRequest};
52pub use webx_core::middleware::{IMiddleware, MiddlewareSlot};
53pub use webx_core::mode::AppMode;
54pub use webx_core::pagination::{PagedRequest, PagedResponse};
55pub use webx_core::paths::{
56    app_base, framework_root, looks_like_app_base, looks_like_framework_root,
57};
58pub use webx_core::pipeline::{IPipelineBehavior, Next};
59pub use webx_core::problem::{FieldError, ProblemDetails};
60pub use webx_core::request_context::RequestContext;
61pub use webx_core::route::catalog::{
62    EndpointCatalog, EndpointDescriptor, EndpointInfo, IEndpointCatalog,
63};
64pub use webx_core::route::diagnostics::{
65    duplicate_handlers, format_route_diagnostics, orphan_handlers, orphan_route_details,
66    orphan_routes, route_snapshots,
67};
68pub use webx_core::routing::{HttpMethod, IEndpoint, IRouter, RouteMeta};
69
70// --- DI extensions ---
71pub use webx_core::route::binding;
72pub use webx_core::route::binding::RequestModel;
73pub use webx_core::route::ext::{is_mediator_active, should_scan_endpoints, IServiceCollectionExt};
74pub use webx_core::route::scan::{
75    AuthorizeRule, BoxedDispatch, BoxedDispatchFn, BoxedDispatchFuture, HandlerCache, HandlerEntry,
76    HandlerRegistration, HandlerRegistry, ParamMeta, RequestParamEntry, ResponseData,
77    RouteDispatch, RouteDispatchFn, RouteEntry,
78};
79
80// --- HTTP layer ---
81pub use webx_host::auth_jwt::{init_jwt_secret, jwt_middleware, jwt_secret, JwtAuth, JwtClaims};
82pub use webx_host::authz::collect_authorizers;
83pub use webx_host::authz::resource_auth_middleware;
84pub use webx_host::authz::{AuthorizerSet, ResourceAuthorization};
85pub use webx_host::compression::{compress_gzip, CompressionConfig, CompressionMiddleware};
86pub use webx_host::context::{HttpContext, HttpRequest, HttpResponse};
87pub use webx_host::cors::{CorsConfig, CorsMiddleware};
88pub use webx_host::diagnostics::log_startup_diagnostics;
89pub use webx_host::endpoint::{
90    ControllerEndpoint, RequestEndpoint, StaticHtmlEndpoint, StaticJsonEndpoint,
91};
92pub use webx_host::health::{HealthCheckEntry, HealthCheckFn, HealthCheckRegistry, HealthStatus};
93pub use webx_host::memory_cache::MemoryCache;
94pub use webx_host::pipeline::{HandlerFn, MiddlewarePipeline};
95pub use webx_host::rate_limit::{RateLimitMiddleware, RateLimiter};
96pub use webx_host::request_id::RequestIdMiddleware;
97pub use webx_host::request_tracing::RequestTracing;
98pub use webx_host::router::Router;
99pub use webx_host::security_headers::SecurityHeadersMiddleware;
100pub use webx_host::server::{Host, HostAppBuilder, HostBuilder, Server, ServerHandle};
101#[cfg(feature = "testing")]
102pub use webx_host::testing::{free_port, spawn, spawn_with_health, wait_until_ready, TestServer};
103pub use webx_host::timing::TimingMiddleware;
104
105// --- Mediator ---
106pub use webx_core::mediator::Mediator;
107
108// --- Web (SPA) ---
109pub use webx_spa::SpaMiddleware;
110
111/// Static file hosting, including files compiled into the executable.
112///
113/// ```ignore
114/// // build.rs: webx::builder().web_root("wwwroot").build()
115/// #[webx::main(embed)]
116/// async fn main() {
117///     Host::builder().use_spa("wwwroot").build()
118/// }
119/// ```
120pub mod spa {
121    pub use webx_spa::{
122        embed_assets, inventory, ContentEncoding, EmbeddedAsset, EmbeddedAssets, SpaMiddleware,
123        SpaSource, EMBED_ENV,
124    };
125}
126
127/// Files compiled into the executable by `#[webx::main(embed)]`, read by path.
128///
129/// ```ignore
130/// let config = webx::assets::read_str("config/default.json");
131/// ```
132pub mod assets {
133    pub use webx_spa::assets::{read, read_str};
134}
135
136// --- OpenAPI ---
137pub use webx_openapi::{generate_openapi_spec, APIUI_HTML};
138
139// --- Macros ---
140#[doc(hidden)]
141pub use webx_macros::{__webx_category, __webx_description, __webx_display};
142pub use webx_macros::{
143    authorize, category, delete, description, display, embed_assets, endpoint, get, handler, main,
144    post, put, WebxRequestMeta,
145};
146
147// --- Re-export rust_dix (for manual registration, #[inject] auto-registration, and module blocks) ---
148pub use rust_dix;
149pub use rust_dix::inject;
150pub use rust_dix::ScopeFactory;
151pub use rust_dix_macros;
152pub use rust_dix_macros::{module, Inject};
153
154// --- Re-export common dependencies ---
155pub use async_trait::async_trait;
156pub use hyper;
157/// Compile-time registration used by the derive macros.
158pub use inventory;
159pub use serde;
160pub use serde_json;
161pub use tokio;
webx/lib.rs

webx/
lib.rs
