Rust API Reference

Rust API Reference v0.17.0-rc.4¶

Functions¶

schema_query_only()¶

Create a simple schema configuration with only Query type.

This is a convenience function for schemas that only have queries.

Returns:

A QueryOnlyConfig with default settings

Signature:

pub fn schema_query_only() -> QueryOnlyConfig

Example:

let result = schema_query_only();

Returns: QueryOnlyConfig

schema_query_mutation()¶

Create a schema configuration with Query and Mutation types.

This is a convenience function for schemas with queries and mutations but no subscriptions.

Returns:

A QueryMutationConfig with default settings

Signature:

pub fn schema_query_mutation() -> QueryMutationConfig

Example:

let result = schema_query_mutation();

Returns: QueryMutationConfig

schema_full()¶

Create a schema configuration with all three root types.

This is a convenience function for fully-featured schemas.

Returns:

A FullSchemaConfig with default settings

Signature:

pub fn schema_full() -> FullSchemaConfig

Example:

let result = schema_full();

Returns: FullSchemaConfig

Types¶

ApiKeyConfig¶

API Key authentication configuration

App¶

Spikard application builder.

Methods¶

new()¶

Create a new application with the default server configuration.

Signature:

pub fn new() -> App

Example:

let result = App::new();

Returns: App

on_request()¶

Register an on_request lifecycle hook (runs before validation and handler dispatch).

Signature:

pub fn on_request(&self, hook: &str) -> App

Example:

let result = instance.on_request("value");

Parameters:

Returns: App

pre_validation()¶

Register a pre_validation lifecycle hook (runs after on_request, before validation).

Signature:

pub fn pre_validation(&self, hook: &str) -> App

Example:

let result = instance.pre_validation("value");

Parameters:

Returns: App

pre_handler()¶

Register a pre_handler lifecycle hook (runs after validation, before the handler).

Signature:

pub fn pre_handler(&self, hook: &str) -> App

Example:

let result = instance.pre_handler("value");

Parameters:

Returns: App

on_response()¶

Register an on_response lifecycle hook (runs after a successful handler response).

Signature:

pub fn on_response(&self, hook: &str) -> App

Example:

let result = instance.on_response("value");

Parameters:

Returns: App

on_error()¶

Register an on_error lifecycle hook (runs when the handler returns an error).

Signature:

pub fn on_error(&self, hook: &str) -> App

Example:

let result = instance.on_error("value");

Parameters:

Returns: App

register_graphql_route()¶

Register a /graphql-style route backed by one of Spikard's built-in async-graphql test schemas.

This is a binding-friendly entry point: unlike spikard_graphql::GraphQLHandler, which is generic over the GraphQL root types and therefore cannot cross an FFI boundary, this method is monomorphic. Callers select a schema by name and the concrete GraphQLHandler<Query, Mutation, Subscription> is constructed internally and registered as an Arc<dyn Handler>.

The built-in schemas exist to exercise Spikard's GraphQL execution path end to end (see fixtures/graphql_schema.json); they are not meant to be extended with application-specific fields. Hosts that need a custom GraphQL schema should build their own GraphQLHandler in Rust and register it via App::route.

Errors:

Returns AppError::GraphQL if schema_type is not a recognized built-in schema name, and AppError::Route if route construction fails.

Signature:

pub fn register_graphql_route(&self, path: &str, method: Method, schema_type: &str, config: SchemaConfig) -> Result<App, AppError>

Example:

let result = instance.register_graphql_route("value", Method::default(), "value", SchemaConfig::default())?;

Parameters:

Returns: App

Errors: Returns Err(AppError).

register_graphql_sdl_route()¶

Register a /graphql-style route backed by an arbitrary SDL schema string, with field resolution driven by a static response_data JSON tree instead of hand-written Rust resolvers.

This is the dynamic-schema counterpart to App::register_graphql_route: instead of selecting one of Spikard's built-in test schemas by name, callers supply their own SDL and a JSON tree shaped like the successful data payload each query should produce. Every field resolver is generic — it navigates response_data by field name — so argument-dependent results (e.g. user(id: "user-42")) must already be baked into response_data at the correct path. See spikard_graphql::dynamic for the full resolver-data encoding and field-level-error support via config.field_errors.

Errors:

Returns AppError::GraphQL if the SDL cannot be parsed or fails dynamic-schema validation (e.g. an unsupported type kind, duplicate field names), and AppError::Route if route construction fails.

Signature:

pub fn register_graphql_sdl_route(&self, path: &str, method: Method, sdl: &str, response_data: serde_json::Value, config: DynamicSchemaConfig) -> Result<App, AppError>

Example:

let result = instance.register_graphql_sdl_route("value", Method::default(), "value", std::collections::HashMap::new(), DynamicSchemaConfig::default())?;

Parameters:

Returns: App

Errors: Returns Err(AppError).

merge_axum_router()¶

Attach an existing Axum router to this application, returning ownership.

Signature:

pub fn merge_axum_router(&self, router: &str) -> App

Example:

let result = instance.merge_axum_router("value");

Parameters:

Returns: App

attach_axum_router()¶

Attach an Axum router using a mutable reference for incremental configuration.

Signature:

pub fn attach_axum_router(&self, router: &str) -> App

Example:

let result = instance.attach_axum_router("value");

Parameters:

Returns: App

into_router()¶

Build the underlying Axum router.

Errors:

Returns an error if server or router construction fails.

Signature:

pub fn into_router(&self) -> Result<String, AppError>

Example:

let result = instance.into_router()?;

Returns: String

Errors: Returns Err(AppError).

into_router_and_config()¶

Decompose the application into its Axum router and server configuration.

This is the low-level escape hatch used by the C FFI layer to start the server on a background thread while retaining the bind address from the caller-supplied ServerConfig. Prefer App::run for normal use.

Errors:

Returns an error if router construction fails.

Signature:

pub fn into_router_and_config(&self) -> Result<String, AppError>

Example:

let result = instance.into_router_and_config()?;

Returns: String

Errors: Returns Err(AppError).

default()¶

Signature:

pub fn default() -> App

Example:

let result = App::default();

Returns: App

AsyncApiConfig¶

AsyncAPI HTTP endpoint configuration

BackgroundJobMetadata¶

Methods¶

default()¶

Signature:

pub fn default() -> BackgroundJobMetadata

Example:

let result = BackgroundJobMetadata::default();

Returns: BackgroundJobMetadata

BackgroundTaskConfig¶

Configuration for in-process background task execution.

Methods¶

default()¶

Signature:

pub fn default() -> BackgroundTaskConfig

Example:

let result = BackgroundTaskConfig::default();

Returns: BackgroundTaskConfig

CompressionConfig¶

Compression configuration shared across runtimes

Methods¶

default()¶

Signature:

pub fn default() -> CompressionConfig

Example:

let result = CompressionConfig::default();

Returns: CompressionConfig

ContactInfo¶

Contact information

CorsConfig¶

CORS configuration for a route

Methods¶

allowed_methods_joined()¶

Get the cached joined methods string for preflight responses

Signature:

pub fn allowed_methods_joined(&self) -> String

Example:

let result = instance.allowed_methods_joined();

Returns: String

allowed_headers_joined()¶

Get the cached joined headers string for preflight responses

Signature:

pub fn allowed_headers_joined(&self) -> String

Example:

let result = instance.allowed_headers_joined();

Returns: String

is_origin_allowed()¶

Check if an origin is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

pub fn is_origin_allowed(&self, origin: &str) -> bool

Example:

let result = instance.is_origin_allowed("value");

Parameters:

Returns: bool

is_method_allowed()¶

Check if a method is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

pub fn is_method_allowed(&self, method: &str) -> bool

Example:

let result = instance.is_method_allowed("value");

Parameters:

Returns: bool

default()¶

Signature:

pub fn default() -> CorsConfig

Example:

let result = CorsConfig::default();

Returns: CorsConfig

DynamicSchemaConfig¶

Configuration for building and executing a dynamic-SDL schema.

FieldErrorSpec¶

A field-level error to inject at a specific response path.

path is the dot-separated sequence of field names from the operation root to the field that should fail, e.g. "user" for a top-level field or "order.customer" for a nested one.

FullSchemaConfig¶

Configuration for fully-featured schemas with Query, Mutation, and Subscription types

Methods¶

default()¶

Signature:

pub fn default() -> FullSchemaConfig

Example:

let result = FullSchemaConfig::default();

Returns: FullSchemaConfig

GraphQlRouteConfig¶

Configuration for GraphQL routes

Provides a builder pattern for configuring GraphQL route parameters for the Spikard HTTP server's routing system.

Methods¶

new()¶

Create a new GraphQL route configuration with defaults

Default values:

• path: "/graphql"
• method: "POST"
• enable_playground: false

Signature:

pub fn new() -> GraphQlRouteConfig

Example:

let result = GraphQlRouteConfig::new();

Returns: GraphQlRouteConfig

path()¶

Set the HTTP path for the GraphQL endpoint

Signature:

pub fn path(&self, path: &str) -> GraphQlRouteConfig

Example:

let result = instance.path("value");

Parameters:

Returns: GraphQlRouteConfig

method()¶

Set the HTTP method for the GraphQL endpoint

Signature:

pub fn method(&self, method: &str) -> GraphQlRouteConfig

Example:

let result = instance.method("value");

Parameters:

Returns: GraphQlRouteConfig

enable_playground()¶

Enable or disable the GraphQL Playground UI

Signature:

pub fn enable_playground(&self, enable: bool) -> GraphQlRouteConfig

Example:

let result = instance.enable_playground(true);

Parameters:

Returns: GraphQlRouteConfig

description()¶

Set a custom description for documentation

Signature:

pub fn description(&self, description: &str) -> GraphQlRouteConfig

Example:

let result = instance.description("value");

Parameters:

Returns: GraphQlRouteConfig

get_path()¶

Get the configured path

Signature:

pub fn get_path(&self) -> String

Example:

let result = instance.get_path();

Returns: String

get_method()¶

Get the configured method

Signature:

pub fn get_method(&self) -> String

Example:

let result = instance.get_method();

Returns: String

is_playground_enabled()¶

Check if playground is enabled

Signature:

pub fn is_playground_enabled(&self) -> bool

Example:

let result = instance.is_playground_enabled();

Returns: bool

get_description()¶

Get the description if set

Signature:

pub fn get_description(&self) -> Option<String>

Example:

let result = instance.get_description();

Returns: Option<String>

default()¶

Signature:

pub fn default() -> GraphQlRouteConfig

Example:

let result = GraphQlRouteConfig::default();

Returns: GraphQlRouteConfig

GraphQlSubscriptionSnapshot¶

Snapshot of a GraphQL subscription exchange over WebSocket.

GrpcConfig¶

Configuration for gRPC support

Controls how the server handles gRPC requests, including compression, timeouts, and protocol settings.

Stream Limits¶

This configuration enforces message-level size limits but delegates concurrent stream limiting to the HTTP/2 transport layer:

• Message Size Limits: The max_message_size field is enforced per individual message (request or response) in both unary and streaming RPCs. When a single message exceeds this limit, the request is rejected with PAYLOAD_TOO_LARGE (HTTP 413).

• Concurrent Stream Limits: The max_concurrent_streams is an advisory configuration passed to the HTTP/2 layer for connection-level stream negotiation. The HTTP/2 transport automatically enforces this limit and returns GOAWAY frames when exceeded. Applications should not rely on custom enforcement of this limit.

• Stream Response Size Limits: The max_stream_response_bytes field caps the total encoded bytes emitted across a server-streaming or bidi-streaming response. When the cumulative size exceeds the limit, the stream is terminated with tonic::Status::resource_exhausted. Defaults to None (unbounded).

Methods¶

default()¶

Signature:

pub fn default() -> GrpcConfig

Example:

let result = GrpcConfig::default();

Returns: GrpcConfig

Handler¶

Handler trait that all language bindings must implement

This trait is completely language-agnostic. Each binding (Python, Node, WASM) implements this trait to bridge their runtime to our HTTP server.

Methods¶

call()¶

Handle an HTTP request

Takes the extracted request data and returns a future that resolves to either:

• Ok(Response): A successful HTTP response
• Err((StatusCode, String)): An error with status code and message

Signature:

pub async fn call(&self, request: Request, request_data: RequestData) -> HandlerResult

Example:

let result = instance.call(Request::default(), RequestData::default()).await;

Parameters:

Returns: HandlerResult

prefers_raw_json_body()¶

Whether this handler prefers consuming RequestData::raw_body over the parsed RequestData::body for JSON requests.

When true, the server may skip eager JSON parsing when there is no request-body schema validator attached to the route.

Signature:

pub fn prefers_raw_json_body(&self) -> bool

Example:

let result = instance.prefers_raw_json_body();

Returns: bool

prefers_parameter_extraction()¶

Whether this handler wants to perform its own parameter validation/extraction (path/query/header/cookie).

When true, the server will skip ParameterValidator::validate_and_extract in ValidatingHandler. This is useful for language bindings which need to transform validated parameters into language-specific values (e.g., Python kwargs) without duplicating work. When false, the server stores validated output in RequestData::validated_params.

Signature:

pub fn prefers_parameter_extraction(&self) -> bool

Example:

let result = instance.prefers_parameter_extraction();

Returns: bool

wants_headers()¶

Whether this handler needs the parsed headers map in RequestData.

When false, the server may skip building RequestData::headers for requests without a body. (Requests with bodies still typically need Content-Type decisions.)

Signature:

pub fn wants_headers(&self) -> bool

Example:

let result = instance.wants_headers();

Returns: bool

wants_cookies()¶

Whether this handler needs the parsed cookies map in RequestData.

When false, the server may skip parsing cookies for requests without a body.

Signature:

pub fn wants_cookies(&self) -> bool

Example:

let result = instance.wants_cookies();

Returns: bool

wants_request_extensions()¶

Whether this handler needs RequestData stored in request extensions.

When false, the server avoids inserting RequestData into extensions to skip cloning in hot paths.

Signature:

pub fn wants_request_extensions(&self) -> bool

Example:

let result = instance.wants_request_extensions();

Returns: bool

static_response()¶

Return a pre-built static response if this handler always produces the same output. When Some, the server bypasses the full middleware pipeline and serves the pre-built response directly.

Signature:

pub fn static_response(&self) -> Option<StaticResponse>

Example:

let result = instance.static_response();

Returns: Option<StaticResponse>

IntoHandler¶

Convert user-facing handler functions into the low-level Handler trait.

Methods¶

into_handler()¶

Convert this value into a shared request handler.

Signature:

pub fn into_handler(&self) -> Handler

Example:

let result = instance.into_handler();

Returns: Handler

JsonRpcConfig¶

JSON-RPC server configuration

Methods¶

default()¶

Signature:

pub fn default() -> JsonRpcConfig

Example:

let result = JsonRpcConfig::default();

Returns: JsonRpcConfig

JsonRpcMethodInfo¶

JSON-RPC method metadata for routes that support JSON-RPC

This struct captures the metadata needed to expose HTTP routes as JSON-RPC methods, enabling discovery and documentation of RPC-compatible endpoints.

JwtConfig¶

JWT authentication configuration

LicenseInfo¶

License information

OpenApiConfig¶

OpenAPI configuration

Methods¶

default()¶

Signature:

pub fn default() -> OpenApiConfig

Example:

let result = OpenApiConfig::default();

Returns: OpenApiConfig

ParseRequest¶

Request body for POST /asyncapi/parse

ParseResult¶

Full parse result returned by POST /asyncapi/parse

ParsedChannel¶

A single channel extracted from an AsyncAPI spec

ParsedMessage¶

A resolved message (name + JSON Schema)

ParsedOperation¶

A single operation extracted from an AsyncAPI spec

ProblemDetails¶

RFC 9457 Problem Details for HTTP APIs

A machine-readable format for specifying errors in HTTP API responses. Per RFC 9457, all fields are optional. The type field defaults to "about:blank" if not specified.

Content-Type¶

Responses using this struct should set:

Content-Type: application/problem+json

{
  "type": "<https://spikard.dev/errors/validation-error",>
  "title": "Request Validation Failed",
  "status": 422,
  "detail": "2 validation errors in request body",
  "errors": [...]
}

Methods¶

with_detail()¶

Set the detail field

Signature:

pub fn with_detail(&self, detail: &str) -> ProblemDetails

Example:

let result = instance.with_detail("value");

Parameters:

Returns: ProblemDetails

with_instance()¶

Set the instance field

Signature:

pub fn with_instance(&self, instance: &str) -> ProblemDetails

Example:

let result = instance.with_instance("value");

Parameters:

Returns: ProblemDetails

not_found()¶

Create a not found error

Signature:

pub fn not_found(detail: &str) -> ProblemDetails

Example:

let result = ProblemDetails::not_found("value");

Parameters:

Returns: ProblemDetails

method_not_allowed()¶

Create a method not allowed error

Signature:

pub fn method_not_allowed(detail: &str) -> ProblemDetails

Example:

let result = ProblemDetails::method_not_allowed("value");

Parameters:

Returns: ProblemDetails

internal_server_error()¶

Create an internal server error

Signature:

pub fn internal_server_error(detail: &str) -> ProblemDetails

Example:

let result = ProblemDetails::internal_server_error("value");

Parameters:

Returns: ProblemDetails

bad_request()¶

Create a bad request error

Signature:

pub fn bad_request(detail: &str) -> ProblemDetails

Example:

let result = ProblemDetails::bad_request("value");

Parameters:

Returns: ProblemDetails

to_json()¶

Serialize to JSON string

Errors: Returns an error if the serialization fails.

Signature:

pub fn to_json(&self) -> Result<String, Error>

Example:

let result = instance.to_json()?;

Returns: String

Errors: Returns Err(Error).

to_json_pretty()¶

Serialize to pretty JSON string

Errors: Returns an error if the serialization fails.

Signature:

pub fn to_json_pretty(&self) -> Result<String, Error>

Example:

let result = instance.to_json_pretty()?;

Returns: String

Errors: Returns Err(Error).

QueryMutationConfig¶

Configuration for schemas with Query and Mutation types

Methods¶

default()¶

Signature:

pub fn default() -> QueryMutationConfig

Example:

let result = QueryMutationConfig::default();

Returns: QueryMutationConfig

QueryOnlyConfig¶

Configuration for schemas with only Query type

Methods¶

default()¶

Signature:

pub fn default() -> QueryOnlyConfig

Example:

let result = QueryOnlyConfig::default();

Returns: QueryOnlyConfig

RateLimitConfig¶

Rate limiting configuration shared across runtimes

Methods¶

default()¶

Signature:

pub fn default() -> RateLimitConfig

Example:

let result = RateLimitConfig::default();

Returns: RateLimitConfig

Request¶

Response¶

HTTP Response with custom status code, headers, and content

Methods¶

set_header()¶

Set a header

Signature:

pub fn set_header(&self, key: &str, value: &str)

Example:

instance.set_header("value", "value");

Parameters:

Returns: No return value.

set_cookie()¶

Set a cookie in the response

Signature:

pub fn set_cookie(&self, key: &str, value: &str, secure: bool, http_only: bool, max_age: Option<i64>, domain: Option<String>, path: Option<String>, same_site: Option<String>)

Example:

instance.set_cookie("value", "value", true, true, 42, "value", "value", "value");

Parameters:

Returns: No return value.

default()¶

Signature:

pub fn default() -> Response

Example:

let result = Response::default();

Returns: Response

ResponseSnapshot¶

Snapshot of an Axum response used by higher-level language bindings.

Methods¶

text()¶

Return response body as UTF-8 string.

Signature:

pub fn text(&self) -> Result<String, FromUtf8Error>

Example:

let result = instance.text()?;

Returns: String

Errors: Returns Err(FromUtf8Error).

header()¶

Lookup header by case-insensitive name.

Signature:

pub fn header(&self, name: &str) -> Option<String>

Example:

let result = instance.header("value");

Parameters:

Returns: Option<String>

RouteBuilder¶

Builder for defining a route.

Methods¶

new()¶

Create a new builder for the provided HTTP method and path.

Signature:

pub fn new(method: Method, path: &str) -> RouteBuilder

Example:

let result = RouteBuilder::new(Method::default(), "value");

Parameters:

Returns: RouteBuilder

handler_name()¶

Assign an explicit handler name.

Signature:

pub fn handler_name(&self, name: &str) -> RouteBuilder

Example:

let result = instance.handler_name("value");

Parameters:

Returns: RouteBuilder

request_schema_json()¶

Provide a raw JSON schema for the request body.

Signature:

pub fn request_schema_json(&self, schema: serde_json::Value) -> RouteBuilder

Example:

let result = instance.request_schema_json(std::collections::HashMap::new());

Parameters:

Returns: RouteBuilder

response_schema_json()¶

Provide a raw JSON schema for the response body.

Signature:

pub fn response_schema_json(&self, schema: serde_json::Value) -> RouteBuilder

Example:

let result = instance.response_schema_json(std::collections::HashMap::new());

Parameters:

Returns: RouteBuilder

params_schema_json()¶

Provide a raw JSON schema for request parameters.

Signature:

pub fn params_schema_json(&self, schema: serde_json::Value) -> RouteBuilder

Example:

let result = instance.params_schema_json(std::collections::HashMap::new());

Parameters:

Returns: RouteBuilder

file_params_json()¶

Provide multipart file parameter configuration.

Signature:

pub fn file_params_json(&self, schema: serde_json::Value) -> RouteBuilder

Example:

let result = instance.file_params_json(std::collections::HashMap::new());

Parameters:

Returns: RouteBuilder

cors()¶

Attach a CORS configuration for this route.

Signature:

pub fn cors(&self, cors: CorsConfig) -> RouteBuilder

Example:

let result = instance.cors(CorsConfig::default());

Parameters:

Returns: RouteBuilder

compression()¶

Attach a compression configuration for this route.

Signature:

pub fn compression(&self, compression: CompressionConfig) -> RouteBuilder

Example:

let result = instance.compression(CompressionConfig::default());

Parameters:

Returns: RouteBuilder

body_limit()¶

Attach a per-route maximum request body size in bytes, overriding the server-global default.

Signature:

pub fn body_limit(&self, max_bytes: usize) -> RouteBuilder

Example:

let result = instance.body_limit(42);

Parameters:

Returns: RouteBuilder

request_timeout()¶

Attach a per-route request timeout in seconds, overriding the server-global default.

Signature:

pub fn request_timeout(&self, seconds: u64) -> RouteBuilder

Example:

let result = instance.request_timeout(42);

Parameters:

Returns: RouteBuilder

sync()¶

Mark the route as synchronous.

Signature:

pub fn sync(&self) -> RouteBuilder

Example:

let result = instance.sync();

Returns: RouteBuilder

handler_dependencies()¶

Declare the dependency keys that must be resolved before this handler runs.

Signature:

pub fn handler_dependencies(&self, dependencies: Vec<String>) -> RouteBuilder

Example:

let result = instance.handler_dependencies(vec![]);

Parameters:

Returns: RouteBuilder

SchemaConfig¶

Configuration for GraphQL schema building.

Encapsulates all schema-level configuration options including introspection control, complexity limits, and depth limits.

Methods¶

default()¶

Signature:

pub fn default() -> SchemaConfig

Example:

let result = SchemaConfig::default();

Returns: SchemaConfig

ServerConfig¶

Server configuration

Methods¶

default()¶

Signature:

pub fn default() -> ServerConfig

Example:

let result = ServerConfig::default();

Returns: ServerConfig

ServerInfo¶

Server information

SseEvent¶

An individual SSE event

Represents a single Server-Sent Event to be sent to a connected client. Events can have an optional type, ID, and retry timeout for advanced scenarios.

SSE Format¶

Events are serialized to the following text format:

event: event_type
data: {"json":"value"}
id: event-123
retry: 3000

Methods¶

with_id()¶

Set the event ID for client-side reconnection support

Sets an ID that clients can use to resume from this point if they disconnect. The client sends this ID back in the Last-Event-ID header when reconnecting.

Signature:

pub fn with_id(&self, id: &str) -> SseEvent

Example:

use serde_json::json;
use spikard_http::sse::SseEvent;

let event = SseEvent::new(json!({"count": 1}))
    .with_id("event-1");
```rust

**Parameters:**

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | `String` | Yes | Unique identifier for this event |

**Returns:** `SseEvent`

###### with_retry()

Set the retry timeout for client reconnection

Sets the time in milliseconds clients should wait before attempting to reconnect
if the connection is lost. The client browser will automatically handle reconnection.

**Signature:**

```rust
pub fn with_retry(&self, retry_ms: u64) -> SseEvent

Example:

use serde_json::json;
use spikard_http::sse::SseEvent;

let event = SseEvent::new(json!({"data": "value"}))
    .with_retry(5000); // Reconnect after 5 seconds
```rust

**Parameters:**

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `retry_ms` | `u64` | Yes | Retry timeout in milliseconds |

**Returns:** `SseEvent`

---

#### StaticFilesConfig

Static file serving configuration

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `directory` | `String` | — | Directory path to serve |
| `route_prefix` | `String` | — | URL path prefix (e.g., "/static") |
| `index_file` | `bool` | `serde(default = "default_true")` | Fallback to index.html for directories |
| `cache_control` | `Option<String>` | `None` | Cache-Control header value |

---

#### TestClient

Core test client for making HTTP requests to a Spikard application.

This struct wraps axum-test's TestServer and provides a language-agnostic
interface for making HTTP requests, sending WebSocket connections, and
handling Server-Sent Events. Language bindings wrap this to provide
native API surfaces.

##### Methods

###### graphql_at()

Send a GraphQL query/mutation to a custom endpoint

**Signature:**

```rust
pub async fn graphql_at(&self, endpoint: &str, query: &str, variables: Option<serde_json::Value>, operation_name: Option<String>) -> Result<ResponseSnapshot, SnapshotError>

Example:

let result = instance.graphql_at("value", "value", std::collections::HashMap::new(), "value").await?;

Parameters:

Returns: ResponseSnapshot

Errors: Returns Err(SnapshotError).

graphql()¶

Send a GraphQL query/mutation

Signature:

pub async fn graphql(&self, query: &str, variables: Option<serde_json::Value>, operation_name: Option<String>) -> Result<ResponseSnapshot, SnapshotError>

Example:

let result = instance.graphql("value", std::collections::HashMap::new(), "value").await?;

Parameters:

Returns: ResponseSnapshot

Errors: Returns Err(SnapshotError).

graphql_subscription_at()¶

Send a GraphQL subscription (WebSocket) to a custom endpoint.

Uses the graphql-transport-ws protocol and captures the first next payload. After the first payload is received, this client sends complete to unsubscribe.

Signature:

pub async fn graphql_subscription_at(&self, endpoint: &str, query: &str, variables: Option<serde_json::Value>, operation_name: Option<String>) -> Result<GraphQlSubscriptionSnapshot, SnapshotError>

Example:

let result = instance.graphql_subscription_at("value", "value", std::collections::HashMap::new(), "value").await?;

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Returns Err(SnapshotError).

graphql_subscription()¶

Send a GraphQL subscription (WebSocket).

Uses /graphql as the default subscription endpoint.

Signature:

pub async fn graphql_subscription(&self, query: &str, variables: Option<serde_json::Value>, operation_name: Option<String>) -> Result<GraphQlSubscriptionSnapshot, SnapshotError>

Example:

let result = instance.graphql_subscription("value", std::collections::HashMap::new(), "value").await?;

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Returns Err(SnapshotError).

TestingSseEvent¶

A single Server-Sent Event.

UploadFile¶

Represents an uploaded file from multipart/form-data requests.

This struct provides efficient access to file content with automatic base64 decoding and implements standard I/O traits for compatibility.

Methods¶

as_bytes()¶

Get the raw file content as bytes.

This provides zero-copy access to the underlying buffer.

Signature:

pub fn as_bytes(&self) -> Vec<u8>

Example:

let result = instance.as_bytes();

Returns: Vec<u8>

read_to_string()¶

Read the file content as a UTF-8 string.

Errors:

Returns an error if the content is not valid UTF-8.

Signature:

pub fn read_to_string(&self) -> Result<String, Error>

Example:

let result = instance.read_to_string()?;

Returns: String

Errors: Returns Err(Error).

content_type_or_default()¶

Get the content type, defaulting to "application/octet-stream".

Signature:

pub fn content_type_or_default(&self) -> String

Example:

let result = instance.content_type_or_default();