Crate a3s_boot

Expand description

Progressive Rust web framework primitives for A3S.

a3s-boot is inspired by Nest.js, but keeps the Rust core explicit: modules organize the graph, providers live in a typed container, controllers group routes, request pipeline hooks are framework-neutral, and HTTP serving is delegated to replaceable adapters.

Structs§

ApiVersioning: Adapter-neutral API versioning configuration.
ApplicationGraph: Read-only module graph snapshot for diagnostics and Nest-style devtools.
ApplicationGraphModule: One module node in an ApplicationGraph.
AxumAdapter: Axum-backed HTTP adapter.
BootApplication: Built application with a resolved module graph and framework-neutral routes.
BootApplicationBuilder: Builder for a BootApplication.
BootApplicationContext: Managed application context for provider-only hosts and workers.
BootApplicationHandle: Managed application with idempotent startup and shutdown.
BootFactory: NestFactory-style entrypoint for building managed Boot applications.
BootMicroservice: Managed standalone microservice built from Boot message patterns.
BootRequest: Framework-neutral HTTP request passed to Boot route handlers.
BootResponse: Framework-neutral HTTP response returned by Boot route handlers.
CatchFilter: Exception filter wrapper that only handles selected BootErrorKind values.
ControllerDefinition: Group routes under a common HTTP prefix, similar to a Nest controller.
CookieOptions: Options used by response cookie helpers.
DefaultValuePipe: Built-in Nest-style pipe that replaces missing optional values with a default.
DiscoveredGateway: Snapshot of a resolved WebSocket gateway.
DiscoveredMessagePattern: Snapshot of a resolved microservice message pattern.
DiscoveredModule: Snapshot of a registered module and its local providers.
DiscoveredRoute: Snapshot of a resolved HTTP route.
DiscoveryService: Read-only discovery snapshot for a built Boot application.
DynamicModule: Runtime-built module for configuration-driven imports and providers.
ExecutionContext: Context visible to guards, interceptors, pipes, and filters.
InProcessTransport: In-process transport useful for tests and single-process message dispatch.
InProcessTransportClient: In-process message client backed by a resolved Boot application.
LazyLoadedModule: Provider-only reference returned by LazyModuleLoader.
LazyModuleLoader: Nest-style lazy module loader for provider-only module graphs.
MessagePatternDefinition: Framework-neutral message pattern handler definition.
MiddlewareConsumer: Nest-style route-scoped middleware configuration.
MiddlewareConsumerBuilder
MiddlewareRoute: Route selector used by MiddlewareConsumer.
ModuleRef: Runtime provider container. This is Boot’s Rust equivalent of Nest’s ModuleRef.
OpenApiComponents: OpenAPI components generated or registered by routes.
OpenApiDocument: OpenAPI document generated from resolved Boot routes.
OpenApiExample: Named OpenAPI media example.
OpenApiExternalDocs: OpenAPI external documentation link.
OpenApiHeader: OpenAPI response header metadata.
OpenApiInfo: Basic OpenAPI document information.
OpenApiMediaType: OpenAPI media type metadata.
OpenApiOAuthFlow: OpenAPI OAuth flow metadata.
OpenApiOAuthFlows: OpenAPI OAuth flow map.
OpenApiOperation: OpenAPI operation metadata for one Boot route.
OpenApiParameter: OpenAPI parameter metadata.
OpenApiPathItem: OpenAPI path item containing operations keyed by HTTP method.
OpenApiRef: OpenAPI Reference Object.
OpenApiRequestBody: OpenAPI request body metadata.
OpenApiResponse: OpenAPI response metadata.
OpenApiRouteMetadata: Route-level OpenAPI metadata carried by RouteDefinition.
OpenApiSchema: OpenAPI schema value. This intentionally stays schema-crate neutral.
OpenApiSecurityScheme: OpenAPI security scheme metadata registered by routes.
OpenApiServer: OpenAPI server entry.
OpenApiTag: OpenAPI tag entry.
ParseArrayPipe: Built-in Nest-style pipe that parses separated request values into arrays.
ParseArraySeparatorPipe: Built-in Nest-style pipe that parses request values with a custom separator.
ParseBoolPipe: Built-in Nest-style pipe that parses boolean request values.
ParseEnumPipe: Built-in Nest-style pipe that parses enum-like request values through FromStr.
ParseFloatPipe: Built-in Nest-style pipe that parses floating point request values.
ParseIntPipe: Built-in Nest-style pipe that parses integer request values.
ParseUuidPipe: Built-in Nest-style pipe that validates UUID request values.
ParseUuidVersionPipe: Built-in Nest-style pipe that validates UUID request values with a version constraint.
ProviderDefinition: A provider registration, similar to a Nest provider entry.
ProviderRef: Lazy provider handle for forward-reference-style dependencies.
ProviderToken: Stable lookup key for an injectable provider.
Reflector: Metadata lookup helper over a discovery snapshot.
ResponsePassthrough: Request-bound response metadata handle for Nest-style passthrough response decorators.
RouteDefinition: A framework-neutral route definition.
RouteMatch: Resolved route and decoded path parameters for a method/path lookup.
SerializationInterceptor: Interceptor that shapes JSON response objects using route serialization metadata.
SerializationOptions: JSON response shaping options used by SerializationInterceptor.
SseEvent
StreamableFile: Adapter-neutral file response body, similar to Nest’s StreamableFile.
StreamableFileOptions: Options for Nest-style streamable file responses.
StringTemplateViewEngine: Small string-template engine for tests and lightweight HTML responses.
TestingModule: Compiled test module with an in-process BootApplication.
TestingModuleBuilder: Builder for Nest-style test modules.
TransportContext: Context available to transport guards and interceptors.
TransportExceptionResponse: Handled transport exception response.
TransportExecutionContext: Transport-specific execution details.
TransportMessage: Adapter-neutral microservice transport message.
TransportReply: Reply returned by request-response message pattern handlers.
ValidationOptions: Options for route-level DTO validation.
ViewModule: Module that registers a ViewRenderer provider.
ViewRenderer: Provider that renders view names into HTML responses.
WebSocketContext: Context available to WebSocket guards and interceptors.
WebSocketExceptionResponse: Handled WebSocket exception response.
WebSocketExecutionContext: WebSocket-specific execution details.
WebSocketGatewayConnection: In-process WebSocket gateway connection used by adapters and tests.
WebSocketGatewayDefinition: Framework-neutral WebSocket gateway definition.
WebSocketGatewayInitContext: Context passed to WebSocket gateway initialization hooks.
WebSocketGatewayServer: Adapter-neutral gateway server handle for broadcasting and connection lookup.
WebSocketMessage: Adapter-neutral WebSocket message used by gateways and adapters.
WebSocketSubscriptionDefinition: Handler definition for one WebSocket subscription.

Enums§

ApiVersioningStrategy: Application-wide API version extraction strategy.
BootError: Errors returned while building or serving a Boot application.
BootErrorKind: Stable category for a BootError, useful for Nest-style catch filters.
CookieSameSite: SameSite attribute used for response cookies.
ExecutionProtocol: Protocol handled by an ExecutionContext.
ExecutionTransportKind: Transport handler style visible through protocol-neutral execution context.
HttpMethod: HTTP method understood by Boot route definitions.
MessagePatternKind
MiddlewareOutcome: Result of running a middleware.
OpenApiApiKeyLocation: Location for OpenAPI API key security schemes.
OpenApiParameterLocation: OpenAPI parameter location.
OpenApiReferenceOr: Either an inline OpenAPI object or a Reference Object.
ProviderScope: Lifetime strategy for provider resolution.
RouteVersioning: Version metadata attached to a route or controller.
ShutdownSignal: Shutdown signal names understood by Nest-style shutdown hooks.
UuidVersion: UUID versions accepted by ParseUuidVersionPipe.

Traits§

ExceptionFilter: Maps route/pipeline errors to HTTP responses.
ExecutionInterceptor: Protocol-neutral observer that can run around HTTP, WebSocket, or transport handlers.
FromModuleRef: Builds an injectable value from the module provider graph.
Guard: Decides whether a route handler can run.
HttpAdapter: Adapter that turns a Boot application into a concrete HTTP server/router.
Interceptor: Runs around the handler for cross-cutting behavior.
IntoTransportReply: Return value accepted by request-response message pattern handlers.
IntoWebSocketReply: Return value accepted by WebSocket gateway handlers.
MessageTransport: Adapter trait for message transports such as in-process, Redis, NATS, or Kafka.
Middleware: Request middleware that runs before guards, interceptors, pipes, and handlers.
Module: A module contributes imports, providers, controllers, and routes.
ParseFloatTarget
ParseIntTarget
Pipe: Transforms a request after guards and interceptor before hooks, before handlers run.
ProviderBeforeApplicationShutdown: Lifecycle hook for singleton providers that need async work before listeners close.
ProviderOnApplicationBootstrap: Lifecycle hook for singleton providers that need async startup work.
ProviderOnApplicationShutdown: Lifecycle hook for singleton providers that need async shutdown cleanup.
ProviderOnModuleDestroy: Lifecycle hook for singleton providers that need async teardown before shutdown starts.
ProviderOnModuleInit: Lifecycle hook for singleton providers that need synchronous module init work.
RequestExtractor: Custom request value extractor used by Nest-style controller argument binding.
RequestValuePipe: Transforms a single request value extracted from a path, query, header, or host parameter.
RouteHandler: Type-erased route handler used by adapters.
TransportExceptionFilter: Maps transport pipeline errors to protocol replies.
TransportGuard: Authorization hook for transport message patterns.
TransportInterceptor: Around-handler hook for transport message patterns.
TransportPipe: Message transformation hook for transport message patterns.
Validate: DTO validation hook used by validating route helpers and controller macros.
ValidationSchema: Field metadata used by Nest-style whitelist validation options.
ViewEngine: Rendering backend for Nest-style MVC view responses.
WebSocketConnection: Adapter-neutral WebSocket connection.
WebSocketExceptionFilter: Maps WebSocket gateway errors to outbound messages.
WebSocketGatewayConnectionHook: Hook invoked when a WebSocket client connects to a gateway.
WebSocketGatewayDisconnectHook: Hook invoked when a WebSocket client disconnects from a gateway.
WebSocketGatewayInitHook: Hook invoked when a WebSocket gateway is initialized during application bootstrap.
WebSocketGuard: Authorization hook for WebSocket gateway messages.
WebSocketInterceptor: Around-handler hook for WebSocket gateway messages.
WebSocketOutbound: Outbound writer for adapter-backed WebSocket connections.
WebSocketPipe: Message transformation hook for WebSocket gateways.

Functions§

catch_errors: Build a Nest-style catch filter for selected BootErrorKind values.
extract_request_value
openapi_schema_name
transform_request_value
wait_for_shutdown_signal: Wait for one configured operating-system shutdown signal.

Type Aliases§

BoxFuture: Boxed future used by adapter traits.
OpenApiSecurityRequirement: OpenAPI security requirement object.
Result: Result type used by A3S Boot.
SseStream
StreamableFileStream

Attribute Macros§

Derive Macros§

ValidationSchema

Crate a3s_boot

Crate a3s_boot Copy item path

Structs§

Enums§

Traits§

Functions§

Type Aliases§

Attribute Macros§

Derive Macros§

Crate a3s_boot