Struct ServerConfig 

pub struct ServerConfig {
    pub host: String,
    pub port: u16,
    pub workers: Option<usize>,
    pub request_timeout: Option<Duration>,
    pub max_body_size: usize,
    pub max_connections: Option<usize>,
    pub max_concurrent_requests: Option<usize>,
    pub shutdown_timeout: Duration,
    pub header_read_timeout: Duration,
    pub tcp_nodelay: bool,
    pub connect_info: bool,
}

Configuration for the HTTP server.

Fields are public for reading; the same-named builder methods consume and return the config for fluent construction:

use std::time::Duration;
use kerniq_core::ServerConfig;

let config = ServerConfig::new()
    .host("0.0.0.0")
    .port(3000)
    .workers(4)
    .request_timeout(Duration::from_secs(30))
    .max_body_size(10 * 1024 * 1024);

assert_eq!(config.address(), "0.0.0.0:3000");
assert_eq!(config.workers, Some(4));

Fields

host: String

Interface to bind to. Default: 127.0.0.1.

port: u16

Port to bind to. 0 selects an ephemeral port. Default: 3000.

workers: Option<usize>

Tokio worker threads used by run_blocking. Default: one per CPU core.

request_timeout: Option<Duration>

Maximum time to produce a response. Exceeding it yields 408 REQUEST_TIMEOUT. Default: no timeout.

max_body_size: usize

Maximum request body size in bytes accepted by body extractors (Json, String, Bytes, …). Larger bodies yield 413 PAYLOAD_TOO_LARGE. Default: 2 MiB.

max_connections: Option<usize>

Maximum number of open TCP connections. Default: unlimited.

max_concurrent_requests: Option<usize>

Maximum number of requests processed concurrently. Default: unlimited.

shutdown_timeout: Duration

How long graceful shutdown waits for in-flight requests and background tasks before giving up. Default: 30 seconds.

header_read_timeout: Duration

Maximum time for a client to send the request headers (protects against slow-header attacks). 0 disables it, which removes a per-request timer (a few percent of throughput on trivial endpoints) at the cost of that protection. Default: 30 seconds.

tcp_nodelay: bool

Disable Nagle’s algorithm on accepted sockets. Default: true.

connect_info: bool

Make the peer address available to handlers through ConnectInfo<SocketAddr>. Costs one small allocation per request. Default: true.

Implementations

impl ServerConfig

pub fn new() -> ServerConfig

Creates a configuration with default values.

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

Sets the interface to bind to.

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

Sets the port to bind to.

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

Sets the number of Tokio worker threads used by run_blocking.

pub fn request_timeout(self, timeout: Duration) -> ServerConfig

Sets the per-request timeout.

pub fn max_body_size(self, bytes: usize) -> ServerConfig

Sets the maximum request body size in bytes.

pub fn max_connections(self, max: usize) -> ServerConfig

Limits the number of open TCP connections.

pub fn max_concurrent_requests(self, max: usize) -> ServerConfig

Limits the number of requests processed concurrently.

pub fn shutdown_timeout(self, timeout: Duration) -> ServerConfig

Sets the graceful shutdown timeout.

pub fn header_read_timeout(self, timeout: Duration) -> ServerConfig

Sets the request header read timeout (Duration::ZERO disables it).

pub fn tcp_nodelay(self, enabled: bool) -> ServerConfig

Enables or disables TCP_NODELAY.

pub fn connect_info(self, enabled: bool) -> ServerConfig

Enables or disables ConnectInfo<SocketAddr> for handlers.

pub fn address(&self) -> String

The host:port address, with brackets around IPv6 hosts.

pub fn from_env() -> Result<ServerConfig, ConfigError>

Builds a configuration from defaults overridden by KERNIQ_* environment variables. See ServerConfig::apply_env_vars.

pub fn apply_env(self) -> Result<ServerConfig, ConfigError>

Overrides values from the process environment. See ServerConfig::apply_env_vars.

pub fn apply_env_vars<I, K, V>( self, vars: I, ) -> Result<ServerConfig, ConfigError>

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Overrides values from the given (name, value) pairs, using these variables (durations are in seconds, sizes in bytes):

Variable	Setting
KERNIQ_HOST	host
KERNIQ_PORT	port
KERNIQ_WORKERS	workers
KERNIQ_REQUEST_TIMEOUT	request_timeout
KERNIQ_MAX_BODY_SIZE	max_body_size
KERNIQ_MAX_CONNECTIONS	max_connections
KERNIQ_MAX_CONCURRENT_REQUESTS	max_concurrent_requests
KERNIQ_SHUTDOWN_TIMEOUT	shutdown_timeout
KERNIQ_HEADER_READ_TIMEOUT	header_read_timeout
KERNIQ_TCP_NODELAY	tcp_nodelay
KERNIQ_CONNECT_INFO	connect_info

Unrelated variables are ignored. The result is validated.

pub fn from_file(path: impl AsRef<Path>) -> Result<ServerConfig, ConfigError>

Available on crate feature config-file only.

Loads a configuration from a TOML file. Missing keys use defaults; unknown keys are rejected. Durations are given in seconds.

host = "0.0.0.0"
port = 8080
request_timeout = 30
max_concurrent_requests = 1024

pub fn from_toml_str(text: &str) -> Result<ServerConfig, ConfigError>

Available on crate feature config-file only.

Parses a configuration from a TOML string. See ServerConfig::from_file.

pub fn validate(&self) -> Result<(), ConfigError>

Checks that values are within range.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> ServerConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

where ServerConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ServerConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ServerConfig

impl From<&ServerConfig> for ServeOptions

fn from(config: &ServerConfig) -> ServeOptions

Converts to this type from the input type.

impl PartialEq for ServerConfig

fn eq(&self, other: &ServerConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ServerConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerConfig