Struct ServerConfigBuilder 

pub struct ServerConfigBuilder { /* private fields */ }

Builder for ServerConfig

Provides a fluent API for configuring a Spikard server with dependency injection support.

Dependency Injection

The builder provides methods to register dependencies that will be injected into handlers:

# #[cfg(feature = "di")]
# {
use spikard_http::ServerConfig;
use std::sync::Arc;

let config = ServerConfig::builder()
    .port(3000)
    .provide_value("app_name", "MyApp".to_string())
    .provide_value("max_connections", 100)
    .build();
# }

For factory dependencies that create values on-demand:

# #[cfg(feature = "di")]
# {
use spikard_http::ServerConfig;

let config = ServerConfig::builder()
    .port(3000)
    .provide_value("db_url", "postgresql://localhost/mydb".to_string())
    .build();
# }

Implementations

impl ServerConfigBuilder

pub fn host(self, host: impl Into<String>) -> Self

Set the host address to bind to

pub fn port(self, port: u16) -> Self

Set the port to bind to

pub fn workers(self, workers: usize) -> Self

Set the number of worker threads (unused with tokio, kept for compatibility)

pub fn enable_request_id(self, enable: bool) -> Self

Enable or disable request ID generation and propagation

pub fn max_body_size(self, size: Option<usize>) -> Self

Set maximum request body size in bytes (None = unlimited, not recommended)

pub fn request_timeout(self, timeout: Option<u64>) -> Self

Set request timeout in seconds (None = no timeout)

pub fn compression(self, compression: Option<CompressionConfig>) -> Self

Set compression configuration

pub fn rate_limit(self, rate_limit: Option<RateLimitConfig>) -> Self

Set rate limiting configuration

pub fn jwt_auth(self, jwt_auth: Option<JwtConfig>) -> Self

Set JWT authentication configuration

pub fn api_key_auth(self, api_key_auth: Option<ApiKeyConfig>) -> Self

Set API key authentication configuration

pub fn static_files(self, static_files: Vec<StaticFilesConfig>) -> Self

Add static file serving configuration

pub fn add_static_files(self, static_file: StaticFilesConfig) -> Self

Add a single static file serving configuration

pub fn graceful_shutdown(self, enable: bool) -> Self

Enable or disable graceful shutdown on SIGTERM/SIGINT

pub fn shutdown_timeout(self, timeout: u64) -> Self

Set graceful shutdown timeout in seconds

pub fn openapi(self, openapi: Option<OpenApiConfig>) -> Self

Set OpenAPI documentation configuration

pub fn jsonrpc(self, jsonrpc: Option<JsonRpcConfig>) -> Self

Set JSON-RPC configuration

pub fn lifecycle_hooks(self, hooks: Option<Arc<LifecycleHooks>>) -> Self

Set lifecycle hooks for request/response processing

pub fn background_tasks(self, config: BackgroundTaskConfig) -> Self

Set background task executor configuration

pub fn build(self) -> ServerConfig

Build the ServerConfig

Trait Implementations

impl Clone for ServerConfigBuilder

fn clone(&self) -> ServerConfigBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerConfigBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ServerConfigBuilder

fn default() -> ServerConfigBuilder

Returns the “default value” for a type.