Skip to main content

Module prelude

Module prelude 

Source
Expand description

Prelude for convenient imports

Structs§

Context
Protocol-agnostic request context.
ErrorResponse
A generic error response that can be serialized and sent over the wire.
OpenApiBuilder
Builder for composing OpenAPI specs from multiple sources.
WsSender
WebSocket sender for server-push messaging.

Enums§

ErrorCode
Protocol-agnostic error code that maps to HTTP status, gRPC code, CLI exit code, etc.

Traits§

CliSubcommand
Trait for types that can be mounted as CLI subcommand groups.
Deserialize
A data structure that can be deserialized from any data format supported by Serde.
HttpMount
Trait for types that can be mounted as HTTP route groups.
IntoErrorCode
Trait for converting errors to protocol-agnostic error codes.
JsonRpcMount
Trait for types that can be mounted as JSON-RPC method namespaces.
McpNamespace
Trait for types that can be mounted as MCP tool namespaces.
Serialize
A data structure that can be serialized into any data format supported by Serde.
WsMount
Trait for types that can be mounted as WebSocket method namespaces.

Attribute Macros§

asyncapi
Generate AsyncAPI specification for event-driven services.
capnp
Generate Cap’n Proto schema from an impl block.
cli
Generate a CLI application from an impl block.
connect
Generate Connect protocol schema from an impl block.
graphql
Generate GraphQL schema from an impl block using async-graphql.
graphql_enum
Define a GraphQL enum type.
graphql_input
Define a GraphQL input type.
grpc
Generate Protocol Buffers schema from an impl block.
http
Generate HTTP handlers from an impl block.
jsonrpc
Generate JSON-RPC 2.0 handlers over HTTP.
jsonschema
Generate JSON Schema from an impl block.
markdown
Generate Markdown API documentation from an impl block.
mcp
Generate MCP (Model Context Protocol) tools from an impl block.
openapi
Generate OpenAPI specification without HTTP routing.
openrpc
Generate OpenRPC specification for JSON-RPC services.
program
Blessed preset: CLI application with Markdown docs.
response
Helper attribute for method-level HTTP response customization.
route
Helper attribute for method-level HTTP route customization.
rpc
Blessed preset: JSON-RPC server with OpenRPC spec and serve.
serve
Coordinate multiple protocol handlers into a single server.
server
Blessed preset: HTTP server with OpenAPI and serve.
smithy
Generate Smithy IDL schema from an impl block.
thrift
Generate Apache Thrift schema from an impl block.
tool
Blessed preset: MCP tools with JSON Schema.
ws
Generate WebSocket JSON-RPC handlers from an impl block.

Derive Macros§

Deserialize
Serialize
ServerlessError
Derive macro for error types that implement IntoErrorCode.