Expand description
Core primitives for Caelix.
Macros§
- provider_
dependencies - Declares provider dependencies for manual
Injectableimplementations and factories. Builds the explicit dependency list required by a handwrittenInjectableimplementation.
Structs§
- BadGateway
Exception - Re-exported public API.
Public Caelix type
BadGatewayException. - BadRequest
Exception - Re-exported public API.
Public Caelix type
BadRequestException. - Bytes
- Re-exported public API. A cheaply cloneable and sliceable chunk of contiguous memory.
- Cache
- Re-exported public API.
Public Caelix type
Cache. - Cache
Module - Re-exported public API.
Public Caelix type
CacheModule. - Conflict
Exception - Re-exported public API.
Public Caelix type
ConflictException. - Container
- Re-exported public API.
Public Caelix type
Container. - Controller
Def - Re-exported public API.
Public Caelix type
ControllerDef. - Cookie
- Framework-owned response cookie primitives. A response cookie with secure defaults.
- Default
Throttle Config - Request throttling primitives. Default 60 requests per 60 seconds throttle configuration.
- Event
Bus - Re-exported public API.
Public Caelix type
EventBus. - Event
Handler Def - Re-exported public API.
Public Caelix type
EventHandlerDef. - Event
Module - Re-exported public API.
Public Caelix type
EventModule. - Expectation
Failed Exception - Re-exported public API.
Public Caelix type
ExpectationFailedException. - Failed
Dependency Exception - Re-exported public API.
Public Caelix type
FailedDependencyException. - Forbidden
Exception - Re-exported public API.
Public Caelix type
ForbiddenException. - Gateway
Def - Re-exported public API.
Public Caelix type
GatewayDef. - Gateway
Timeout Exception - Re-exported public API.
Public Caelix type
GatewayTimeoutException. - Gone
Exception - Re-exported public API.
Public Caelix type
GoneException. - Http
Exception - Re-exported public API.
Public Caelix type
HttpException. - Http
Response - Re-exported public API.
Public Caelix type
HttpResponse. - Http
Version NotSupported Exception - Re-exported public API.
Public Caelix type
HttpVersionNotSupportedException. - ImATeapot
Exception - Re-exported public API.
Public Caelix type
ImATeapotException. - Insufficient
Storage Exception - Re-exported public API.
Public Caelix type
InsufficientStorageException. - Internal
Server Error Exception - Re-exported public API.
Public Caelix type
InternalServerErrorException. - IpThrottle
Tracker - Request throttling primitives. Tracks clients by IP, with explicit trusted-proxy support.
- Length
Required Exception - Re-exported public API.
Public Caelix type
LengthRequiredException. - Locked
Exception - Re-exported public API.
Public Caelix type
LockedException. - Logger
- Re-exported public API.
Public Caelix type
Logger. - Loop
Detected Exception - Re-exported public API.
Public Caelix type
LoopDetectedException. - Memory
Cache Options - Re-exported public API.
Public Caelix type
MemoryCacheOptions. - Memory
Cache Store - Re-exported public API.
Public Caelix type
MemoryCacheStore. - Memory
Throttle Store - Request throttling primitives. A bounded, process-local atomic throttle store.
- Message
Context - Re-exported public API. Context made available to a microservice handler.
- Message
Delivery - Re-exported public API. Durable transport delivery details attached to an event handler invocation.
- Message
Handler Def - Re-exported public API. One transport-neutral message handler declared by a microservice.
- Method
NotAllowed Exception - Re-exported public API.
Public Caelix type
MethodNotAllowedException. - Microservice
Def - Re-exported public API. Metadata for one dependency-injected microservice class.
- Misdirected
Request Exception - Re-exported public API.
Public Caelix type
MisdirectedRequestException. - Module
Def - Re-exported public API.
Public Caelix type
ModuleDef. - Module
Metadata - Re-exported public API.
Public Caelix type
ModuleMetadata. - Network
Authentication Required Exception - Re-exported public API.
Public Caelix type
NetworkAuthenticationRequiredException. - Next
- Re-exported public API.
Public Caelix type
Next. - NotAcceptable
Exception - Re-exported public API.
Public Caelix type
NotAcceptableException. - NotExtended
Exception - Re-exported public API.
Public Caelix type
NotExtendedException. - NotFound
Exception - Re-exported public API.
Public Caelix type
NotFoundException. - NotImplemented
Exception - Re-exported public API.
Public Caelix type
NotImplementedException. - Payload
TooLarge Exception - Re-exported public API.
Public Caelix type
PayloadTooLargeException. - Payment
Required Exception - Re-exported public API.
Public Caelix type
PaymentRequiredException. - Precondition
Failed Exception - Re-exported public API.
Public Caelix type
PreconditionFailedException. - Precondition
Required Exception - Re-exported public API.
Public Caelix type
PreconditionRequiredException. - Provider
Def - Re-exported public API.
Public Caelix type
ProviderDef. - Provider
Dependency - Re-exported public API.
Metadata for one resolved provider dependency.
Public Caelix type
ProviderDependency. - Provider
Overrides - Re-exported public API.
Public Caelix type
ProviderOverrides. - Proxy
Authentication Required Exception - Re-exported public API.
Public Caelix type
ProxyAuthenticationRequiredException. - Range
NotSatisfiable Exception - Re-exported public API.
Public Caelix type
RangeNotSatisfiableException. - Request
Context - Re-exported public API.
Public Caelix type
RequestContext. - Request
Header Fields TooLarge Exception - Re-exported public API.
Public Caelix type
RequestHeaderFieldsTooLargeException. - Request
Timeout Exception - Re-exported public API.
Public Caelix type
RequestTimeoutException. - Route
Def - Re-exported public API.
Public Caelix type
RouteDef. - Service
Unavailable Exception - Re-exported public API.
Public Caelix type
ServiceUnavailableException. - Status
Code - Re-exported public API.
An HTTP status code (
status-codein RFC 9110 et al.). - Throttle
- Request throttling primitives. The global request-throttling service.
- Throttle
Module - Request throttling primitives. Global module enabling throttling for macro-generated controller routes.
- Throttle
Options - Request throttling primitives. Runtime throttling configuration.
- Throttle
Policy - Request throttling primitives. A fixed-window request policy.
- Throttle
Store Record - Request throttling primitives. The result of an atomic store increment.
- TooEarly
Exception - Re-exported public API.
Public Caelix type
TooEarlyException. - TooMany
Requests Exception - Re-exported public API.
Public Caelix type
TooManyRequestsException. - Unauthorized
Exception - Re-exported public API.
Public Caelix type
UnauthorizedException. - Unavailable
ForLegal Reasons Exception - Re-exported public API.
Public Caelix type
UnavailableForLegalReasonsException. - Unprocessable
Entity Exception - Re-exported public API.
Public Caelix type
UnprocessableEntityException. - Unsupported
Media Type Exception - Re-exported public API.
Public Caelix type
UnsupportedMediaTypeException. - Upgrade
Required Exception - Re-exported public API.
Public Caelix type
UpgradeRequiredException. - UriToo
Long Exception - Re-exported public API.
Public Caelix type
UriTooLongException. - Variant
Also Negotiates Exception - Re-exported public API.
Public Caelix type
VariantAlsoNegotiatesException. - WebSocket
Close Frame - Re-exported public API.
Public Caelix type
WebSocketCloseFrame. - WebSocket
Error - Re-exported public API.
Public Caelix type
WebSocketError. - WebSocket
Request - Re-exported public API.
Public Caelix type
WebSocketRequest. - WebSocket
Session - Re-exported public API.
Public Caelix type
WebSocketSession.
Enums§
- Body
- Re-exported public API.
A body whose shape isn’t known at the
Response<T>type level — used byResponse::Rawso a handler can return e.g.Response<()>while still sending an arbitrary JSON/text/bytes payload. - LogLevel
- Re-exported public API.
Public Caelix enumeration
LogLevel. - Message
Handler Kind - Re-exported public API. The kind of a message handler.
- Response
- Re-exported public API.
Public Caelix enumeration
Response. - Response
Body - Re-exported public API. Response body: fully buffered, or a live stream of chunks.
- Same
Site - Framework-owned response cookie primitives.
The
SameSiteattribute applied to a response cookie. - WebSocket
Close Code - Re-exported public API.
Public Caelix enumeration
WebSocketCloseCode.
Traits§
- Cache
Store - Re-exported public API.
Public Caelix extension trait
CacheStore. - Controller
- Re-exported public API.
Public Caelix extension trait
Controller. - Event
Handler - Re-exported public API.
Public Caelix extension trait
EventHandler. - Gateway
- Re-exported public API.
Public Caelix extension trait
Gateway. - Guard
- Re-exported public API.
Public Caelix extension trait
Guard. - Injectable
- Re-exported public API.
Public Caelix extension trait
Injectable. - Interceptor
- Re-exported public API.
Public Caelix extension trait
Interceptor. - Into
Caelix Response - Re-exported public API.
Public Caelix extension trait
IntoCaelixResponse. - Microservice
- Re-exported public API.
Implemented by
#[microservice]classes. - Module
- Re-exported public API.
Public Caelix extension trait
Module. - Registerable
Event Handler - Re-exported public API.
Public Caelix extension trait
RegisterableEventHandler. - Registered
WebSocket Gateway - Re-exported public API.
Marker implemented by
#[gateway]for RFC 6455 gateways. It separates path metadata from the transport callbacks so the sameModuleMetadata::gatewayregistration API can also support optional transports such as Socket.IO. - Stream
Ext - Re-exported public API.
An extension trait for
Streams that provides a variety of convenient combinator functions. - Throttle
Config - Request throttling primitives.
Supplies options for
ThrottleModule. - Throttle
Store - Request throttling primitives. Atomic storage used by the throttler.
- Throttle
Tracker - Request throttling primitives. Derives the client identity used in throttle keys.
- WebSocket
Gateway - Re-exported public API.
Public Caelix extension trait
WebSocketGateway.
Functions§
- bootstrap_
module - Re-exported public API.
Runs the
bootstrap_modulepublic API operation. - build_
container - Re-exported public API.
Runs the
build_containerpublic API operation. - build_
container_ with_ overrides - Re-exported public API.
Runs the
build_container_with_overridespublic API operation. - collect_
module_ message_ handlers - Re-exported public API. Collects the transport-neutral handlers declared by a module graph.
- collect_
module_ message_ handlers_ with_ container - Re-exported public API. Collects message handlers while validating dependencies against an existing application container. Transport adapters use this when they register transport-owned values before module construction.
- dropped_
http_ request_ logs - Re-exported public API. Returns the number of enabled HTTP access-log entries dropped because the asynchronous writer queue was full.
- http_
request_ logging_ enabled - Re-exported public API.
Runs the
http_request_logging_enabledpublic API operation. - log
- Re-exported public API.
Runs the
logpublic API operation. - log_
application_ starting - Re-exported public API.
Runs the
log_application_startingpublic API operation. - log_
controller_ routes - Re-exported public API.
Runs the
log_controller_routespublic API operation. - log_
http_ exception - Re-exported public API.
Runs the
log_http_exceptionpublic API operation. - log_
http_ exception_ with_ context - Re-exported public API. Logs a server-side HTTP exception with request correlation metadata.
- log_
http_ request - Re-exported public API.
Runs the
log_http_requestpublic API operation. - log_
module_ initialized - Re-exported public API.
Runs the
log_module_initializedpublic API operation. - log_
module_ routes - Re-exported public API.
Runs the
log_module_routespublic API operation. - log_
provider_ initialized - Re-exported public API.
Runs the
log_provider_initializedpublic API operation. - log_
ready - Re-exported public API. Logs that the server has successfully bound and is ready to accept traffic.
- log_
route_ mapped - Re-exported public API.
Runs the
log_route_mappedpublic API operation. - register_
module - Re-exported public API.
Runs the
register_modulepublic API operation. - register_
module_ controllers - Re-exported public API.
Runs the
register_module_controllerspublic API operation. - shutdown_
module - Re-exported public API.
Runs the
shutdown_modulepublic API operation. - validate_
module - Re-exported public API. Validates a module’s metadata without constructing providers or starting an application.
- validate_
module_ providers - Re-exported public API.
Runs the
validate_module_providerspublic API operation. - visit_
module_ gateways - Re-exported public API.
Runs the
visit_module_gatewayspublic API operation.
Type Aliases§
- BoxBody
Stream - Re-exported public API.
Async sequence of body chunks. Errors use framework
HttpException. - BoxFuture
- Re-exported public API.
Public Caelix type alias
BoxFuture. - Result
- Re-exported public API.
Public Caelix type alias
Result.