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.
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.
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.
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.
OpenApiInfo: Basic OpenAPI document information.
OpenApiMediaType: OpenAPI media type metadata.
OpenApiOperation: OpenAPI operation metadata for one Boot route.
OpenApiParameter: OpenAPI parameter metadata.
OpenApiPathItem: OpenAPI path item containing operations keyed by HTTP method.
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.
OpenApiTag: OpenAPI tag entry.
ProviderDefinition: A provider registration, similar to a Nest provider entry.
ProviderToken: Stable lookup key for an injectable provider.
Reflector: Metadata lookup helper over a discovery snapshot.
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
TestingModule: Compiled test module with an in-process BootApplication.
TestingModuleBuilder: Builder for Nest-style test modules.
TransportContext: Context available to transport guards and interceptors.
TransportExecutionContext: Transport-specific execution details.
TransportMessage: Adapter-neutral microservice transport message.
TransportReply: Reply returned by request-response message pattern handlers.
WebSocketContext: Context available to WebSocket guards and interceptors.
WebSocketExecutionContext: WebSocket-specific execution details.
WebSocketGatewayConnection: In-process WebSocket gateway connection used by adapters and tests.
WebSocketGatewayDefinition: Framework-neutral WebSocket gateway definition.
WebSocketMessage: Adapter-neutral WebSocket message used by gateways and adapters.

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.
OpenApiParameterLocation: OpenAPI parameter location.
ProviderScope: Lifetime strategy for provider resolution.
RouteVersioning: Version metadata attached to a route or controller.

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.
Pipe: Transforms a request after guards and interceptor before hooks, before handlers run.
ProviderOnApplicationBootstrap: Lifecycle hook for singleton providers that need async startup work.
ProviderOnApplicationShutdown: Lifecycle hook for singleton providers that need async shutdown cleanup.
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.
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.
WebSocketConnection: Adapter-neutral WebSocket connection.
WebSocketGuard: Authorization hook for WebSocket gateway messages.
WebSocketInterceptor: Around-handler hook for WebSocket gateway messages.
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

Type Aliases§

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

Crate a3s_boot

Crate a3s_boot Copy item path

Structs§

Enums§

Traits§

Functions§

Type Aliases§

Attribute Macros§

Crate a3s_boot