Struct BootApplicationBuilder 

pub struct BootApplicationBuilder { /* private fields */ }

Builder for a BootApplication.

Implementations

impl BootApplicationBuilder

pub fn new() -> Self

pub fn import<M>(self, module: M) -> Self

where M: Module,

Import a root module.

pub fn import_arc(self, module: Arc<dyn Module>) -> Self

Import a shared root module.

pub fn route(self, route: RouteDefinition) -> Self

Add a framework-neutral route directly to the application shell.

pub fn gateway(self, gateway: WebSocketGatewayDefinition) -> Self

Add a framework-neutral WebSocket gateway directly to the application shell.

pub fn message_pattern(self, pattern: MessagePatternDefinition) -> Self

Add a framework-neutral microservice message pattern directly to the application shell.

pub fn serve_openapi(self, path: impl Into<String>, info: OpenApiInfo) -> Self

Serve a generated OpenAPI document at the given path.

pub fn serve_openapi_ui( self, path: impl Into<String>, document_path: impl Into<String>, info: OpenApiInfo, ) -> Self

Serve a generated OpenAPI document and a Swagger UI page for it.

pub fn global_prefix(self, prefix: impl Into<String>) -> Self

Prefix every route in the built application, for example /api/v1.

pub fn exclude_global_prefix<I>(self, routes: I) -> Self

where I: IntoIterator<Item = MiddlewareRoute>,

Exclude selected HTTP routes from the application-wide global prefix.

pub fn enable_api_versioning(self, versioning: ApiVersioning) -> Self

Enable adapter-neutral API version matching for HTTP routes.

pub fn use_global_middleware<M>(self, middleware: M) -> Self

where M: Middleware,

Add application-wide middleware, similar to Nest middleware.

pub fn use_global_pipe<P>(self, pipe: P) -> Self

where P: Pipe,

Add an application-wide pipe, similar to Nest’s global pipes.

pub fn use_global_websocket_pipe<P>(self, pipe: P) -> Self

where P: WebSocketPipe,

Add an application-wide WebSocket pipe.

pub fn use_global_websocket_guard<G>(self, guard: G) -> Self

where G: WebSocketGuard,

Add an application-wide WebSocket guard.

pub fn use_global_websocket_interceptor<I>(self, interceptor: I) -> Self

where I: WebSocketInterceptor,

Add an application-wide WebSocket interceptor.

pub fn use_global_transport_pipe<P>(self, pipe: P) -> Self

where P: TransportPipe,

Add an application-wide transport pipe.

pub fn use_global_transport_guard<G>(self, guard: G) -> Self

where G: TransportGuard,

Add an application-wide transport guard.

pub fn use_global_transport_interceptor<I>(self, interceptor: I) -> Self

where I: TransportInterceptor,

Add an application-wide transport interceptor.

pub fn use_global_guard<G>(self, guard: G) -> Self

where G: Guard,

Add an application-wide guard, similar to Nest’s global guards.

pub fn use_global_execution_guard<G>(self, guard: G) -> Self

where G: Guard,

Add an application-wide protocol-neutral guard.

pub fn use_global_interceptor<I>(self, interceptor: I) -> Self

where I: Interceptor,

Add an application-wide interceptor, similar to Nest’s global interceptors.

pub fn use_global_execution_interceptor<I>(self, interceptor: I) -> Self

where I: ExecutionInterceptor,

Add an application-wide protocol-neutral interceptor.

pub fn use_global_serialization(self) -> Self

Add the default JSON response serialization interceptor.

pub fn use_global_filter<F>(self, filter: F) -> Self

where F: ExceptionFilter,

Add an application-wide exception filter, similar to Nest’s global filters.

pub fn use_global_catch_filter<I, F>(self, kinds: I, filter: F) -> Self

where I: IntoIterator<Item = BootErrorKind>, F: ExceptionFilter,

Add an application-wide exception filter for selected error kinds.

pub fn use_global_websocket_filter<F>(self, filter: F) -> Self

where F: WebSocketExceptionFilter,

Add an application-wide WebSocket exception filter.

pub fn use_global_websocket_catch_filter<I, F>( self, kinds: I, filter: F, ) -> Self

where I: IntoIterator<Item = BootErrorKind>, F: WebSocketExceptionFilter,

Add an application-wide WebSocket exception filter for selected error kinds.

pub fn use_global_transport_filter<F>(self, filter: F) -> Self

where F: TransportExceptionFilter,

Add an application-wide transport exception filter.

pub fn use_global_transport_catch_filter<I, F>( self, kinds: I, filter: F, ) -> Self

where I: IntoIterator<Item = BootErrorKind>, F: TransportExceptionFilter,

Add an application-wide transport exception filter for selected error kinds.

pub fn use_global_validation(self) -> Self

Enable DTO validation for routes that carry validation metadata.

pub fn use_global_validation_options(self, options: ValidationOptions) -> Self

Enable DTO validation with Nest-style validation options.

pub fn override_provider(self, provider: ProviderDefinition) -> Self

Replace matching module providers before modules build controllers.

This is primarily used by testing utilities to swap provider implementations while preserving the application module graph.

pub fn override_module<M>( self, target_name: impl Into<String>, module: M, ) -> Self

where M: Module,

Replace a module by name before the application graph is registered.

This is primarily used by testing utilities to mirror Nest’s overrideModule(...).useModule(...) workflow. The replacement module is registered wherever a module with the target name appears in the import graph.

pub fn override_module_arc( self, target_name: impl Into<String>, module: Arc<dyn Module>, ) -> Self

Replace a shared module by name before the application graph is registered.

pub fn build(self) -> Result<BootApplication>

Resolve module imports, providers, controllers, and routes.

pub async fn build_async(self) -> Result<BootApplication>

Resolve modules with async provider factories, then build the application.

Trait Implementations

impl Default for BootApplicationBuilder

fn default() -> BootApplicationBuilder

Returns the “default value” for a type.