Struct BootApplication 

pub struct BootApplication { /* private fields */ }

Built application with a resolved module graph and framework-neutral routes.

Implementations

impl BootApplication

pub fn builder() -> BootApplicationBuilder

Create an application builder.

pub fn module_names(&self) -> &[String]

Names of modules included in the application, in registration order.

pub fn routes(&self) -> &[RouteDefinition]

Routes exposed by the application.

pub fn api_versioning(&self) -> Option<&ApiVersioning>

API versioning configuration used for HTTP route matching, when enabled.

pub fn gateways(&self) -> &[WebSocketGatewayDefinition]

WebSocket gateways exposed by the application.

pub fn message_patterns(&self) -> &[MessagePatternDefinition]

Microservice message patterns exposed by the application.

pub fn discovery(&self) -> Result<DiscoveryService>

Build a discovery snapshot for modules, routes, gateways, and message patterns.

pub fn reflector(&self) -> Result<Reflector>

Build a discovery snapshot and metadata reflector.

pub fn openapi(&self, info: OpenApiInfo) -> OpenApiDocument

Generate an OpenAPI 3 document from the resolved route table.

pub fn route_for( &self, method: HttpMethod, path: &str, ) -> Option<&RouteDefinition>

Route registered for a method and the most specific route shape matching a path.

pub fn route_match( &self, method: HttpMethod, path: &str, ) -> Result<Option<RouteMatch<'_>>>

Route and decoded path parameters for a method and path, when one is registered.

pub fn gateway_for(&self, path: &str) -> Option<&WebSocketGatewayDefinition>

pub fn message_pattern_for( &self, pattern: &str, ) -> Option<&MessagePatternDefinition>

pub fn allowed_methods(&self, path: &str) -> Vec<HttpMethod>

HTTP methods registered for the most specific route shape matching a path.

pub fn allowed_methods_header(&self, path: &str) -> Option<String>

Comma-separated HTTP methods for an Allow header on the most specific matching path.

pub fn module_ref(&self) -> &ModuleRef

Provider container available to hosts and controllers.

pub fn lazy_module_loader(&self) -> Result<Arc<LazyModuleLoader>>

Lazy module loader available through the application provider graph.

pub fn get<T>(&self) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a typed provider from the application container.

pub fn get_named<T>(&self, token: &str) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a named provider from the application container.

pub fn get_optional<T>(&self) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve a typed provider when it is present.

pub fn get_optional_named<T>(&self, token: &str) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve a named provider when it is present.

pub async fn call(&self, request: BootRequest) -> Result<BootResponse>

Dispatch a framework-neutral request through the resolved route table.

pub async fn handle(&self, request: BootRequest) -> BootResponse

Dispatch a request and convert unhandled errors into Boot HTTP responses.

pub async fn dispatch_message( &self, message: TransportMessage, ) -> Result<Option<TransportReply>>

Dispatch a microservice transport message through the resolved pattern table.

pub async fn emit_message(&self, message: TransportMessage) -> Result<()>

Dispatch an event-only transport message and ignore any handler reply.

pub async fn bootstrap(&self) -> Result<()>

Run async startup hooks before serving, when the host needs them.

pub async fn shutdown(&self) -> Result<()>

Run async shutdown hooks in reverse registration order.

pub async fn shutdown_with_signal( &self, signal: impl Into<String>, ) -> Result<()>

Run async shutdown hooks with a signal label visible to signal-aware hooks.

pub fn into_adapter<A>(self, adapter: &A) -> Result<A::Output>

where A: HttpAdapter,

Build this application through a concrete HTTP adapter.

pub fn into_message_transport<T>(self, transport: &T) -> Result<T::Output>

where T: MessageTransport,

Build this application through a concrete message transport.

pub async fn serve_with<A>(self, adapter: &A, addr: SocketAddr) -> Result<()>

where A: HttpAdapter,

Serve this application through a concrete HTTP adapter.

Trait Implementations

impl Clone for BootApplication

fn clone(&self) -> BootApplication

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.