For AI agents: the complete documentation index is available at https://a3s-lab.github.io/Boot/en/llms.txt, the full documentation bundle is available at https://a3s-lab.github.io/Boot/en/llms-full.txt, and this page is available as Markdown at https://a3s-lab.github.io/Boot/en/reference/features-and-api.md.
A3S Boot
  • English
  • v0.2.0

      • Feature and API map

      This page navigates the crate's public surface. Use docs.rs as the source of truth for exact trait bounds, method signatures, and Rustdoc.

      Defaults and core

      FeatureDefaultPrimary exports
      axumYesAxumAdapter
      macrosYesModule, provider, HTTP, WebSocket, message, and technique macros
      shutdown-hooksYeswait_for_shutdown_signal, ShutdownSignal
      CoreAlwaysApplication, modules, DI, HTTP, pipeline, OpenAPI, validation, views, testing, discovery

      Application and DI

      AreaPrimary types
      Application creationBootFactory, BootApplication, BootApplicationBuilder
      Non-HTTP shellsBootApplicationContext, BootMicroservice, BootApplicationHandle
      ModulesModule, DynamicModule, LazyModuleLoader, LazyLoadedModule
      ProvidersProviderDefinition, ProviderToken, ProviderScope, ProviderDependency
      ResolutionModuleRef, ProviderRef, FromModuleRef, ContextId, ContextIdFactory
      LifecycleProviderOnModuleInit, ProviderOnApplicationBootstrap, ProviderOnModuleDestroy, ProviderBeforeApplicationShutdown, ProviderOnApplicationShutdown
      InspectionDiscoveryService, Reflector, ApplicationGraph, and discovered types

      HTTP and pipeline

      AreaPrimary types
      AdapterHttpAdapter, AxumAdapter
      RoutesControllerDefinition, RouteDefinition, RouteHandler, HttpMethod
      Request / ResponseBootRequest, BootResponse, ResponsePassthrough
      Extraction and pipesRequestExtractor, RequestValuePipe, ParseIntPipe, ParseBoolPipe, ParseFloatPipe, ParseArrayPipe, ParseEnumPipe, ParseUuidPipe, DefaultValuePipe
      PipelineMiddleware, Guard, Interceptor, ExecutionInterceptor, Pipe, ExceptionFilter, CallHandler, ExecutionContext
      Middleware routingMiddlewareConsumer, MiddlewareConsumerBuilder, MiddlewareRoute, MiddlewareOutcome
      ErrorsBootError, BootErrorKind, Result<T>, catch_errors
      StreamingSseEvent, SseStream, StreamableFile, StreamableFileStream
      CookiesCookieOptions, CookieSameSite
      API versionsApiVersioning, ApiVersioningStrategy, RouteVersioning

      Validation, OpenAPI, and views

      AreaPrimary types
      ValidationValidate, ValidationSchema, ValidationOptions
      SerializationSerializationInterceptor, SerializationOptions
      OpenAPIOpenApiDocument, OpenApiInfo, OpenApiOperation, OpenApiPathItem, OpenApiSchema, OpenApiComponents
      OpenAPI securityOpenApiSecurityScheme, OpenApiSecurityRequirement, OpenApiOAuthFlow, OpenApiOAuthFlows
      ViewsViewModule, ViewEngine, ViewRenderer, StringTemplateViewEngine
      TestingTestingModule, TestingModuleBuilder

      Optional application modules

      FeaturePrimary module and interfaces
      authAuthModule, AuthService, AuthGuard, AuthPrincipal, AuthStrategy
      cacheCacheModule, Cache, CacheStore, CacheInterceptor, InMemoryCacheStore
      compressionCompressionInterceptor, CompressionOptions
      configConfigModule and ACL parsing helpers
      cqrsCqrsModule, CommandBus, QueryBus, EventBus, CqrsContext
      databaseDatabaseModule, Database, DatabaseBackend, DatabaseTransaction
      eventsEventModule, EventEmitter, A3sEventBus, A3sEventProvider
      file-uploadMultipartForm, MultipartField, UploadedFile, MultipartOptions
      healthHealthModule, HealthCheckService, HealthIndicator, HealthReport
      http-clientHttpModule, HttpService, HttpClientBackend, HttpClientOptions
      loggingLoggingModule, Logger, LogSink, LogRecord, request logging enhancers
      queueQueueModule, Queue, QueueBackend, QueueJob, QueueOptions, QueueProcessor
      queue-postgresPostgresQueueBackend
      request-contextRequestContext
      scheduleScheduleModule, Scheduler, ScheduledJob, ScheduleContext
      securityCORS, CSRF, rate-limit, and security-header types
      sessionSessionModule, SessionManager, SessionStore, SessionOptions
      staticStaticModule, StaticFileService, StaticFileOptions
      ilinkModule, client, auth, login, message, and update types under a3s_boot::ilink

      WebSocket and message transports

      AreaPrimary types
      WebSocket definitionsWebSocketGatewayDefinition, WebSocketSubscriptionDefinition
      Connections and messagesWebSocketConnection, WebSocketMessage, WebSocketOutbound, WebSocketGatewayServer
      WebSocket pipelineWebSocketContext, WebSocketGuard, WebSocketPipe, WebSocketInterceptor, WebSocketExceptionFilter
      Message patternsMessagePatternDefinition, MessagePatternKind, TransportMessage, TransportReply
      Transport contractMessageTransport, TransportContext, TransportGuard, TransportPipe, TransportInterceptor, TransportExceptionFilter
      Default transportInProcessTransport, InProcessTransportClient
      Network transportsTCP, Redis, NATS, MQTT, RabbitMQ, Kafka, and gRPC types behind their features

      Attribute macro index

      Application declarations

      module, injectable, controller, websocket_gateway, message_controller, event_listener, schedule.

      HTTP methods and extraction

      all, get, post, put, patch, delete, head, options, their JSON variants, sse, body, request, param, params, query, header, headers, cookie, cookies, host_param, ip, extract, res, uploaded_file, uploaded_files.

      Routing and responses

      host, http_code, redirect, render, serialize, version, versions, version_neutral, validate, skip_validation, metadata, cache_key, cache_ttl.

      Pipeline

      use_guard, use_interceptor, use_pipe, use_filter, catch, apply_decorators.

      OpenAPI and authentication

      operation, tag, request_body, api_param, api_query, api_header, api_response_header, api_extension, api_extra_model, hide_from_openapi, bearer_auth, api_security, api_cookie_auth, api_key_auth, oauth2_auth, open_id_connect_auth.

      WebSocket, messages, events, and scheduling

      subscribe_message, message_body, payload, message_pattern, event_pattern, on_gateway_init, on_gateway_connection, on_gateway_disconnect, on_event, cron, interval, timeout.

      Feature selection rules

      • Start with defaults and add a module only for a real boundary.
      • A library crate should not force every Boot feature on downstream users.
      • Inspect feature unification with cargo tree -e features -p a3s-boot.
      • Run focused tests for production combinations, then cargo check --all-features for a release.
      • Successful compilation of an external transport feature does not prove its broker is configured correctly.