Struct axum_server::HttpConfig

pub struct HttpConfig { /* fields omitted */ }

A configuration for Http.

Implementations

impl HttpConfig

pub fn new() -> HttpConfig

Creates a default Http config.

Examples found in repository

examples/configure_http.rs (line 13)

↕

fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let config = HttpConfig::new()
        .http1_only(true)
        .http2_only(false)
        .max_buf_size(8192)
        .build();

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    axum_server::bind(addr)
        .http_config(config)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

pub fn build(&mut self) -> Self

Builds the config, creating an owned version of it.

Examples found in repository

examples/configure_http.rs (line 17)

↕

fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let config = HttpConfig::new()
        .http1_only(true)
        .http2_only(false)
        .max_buf_size(8192)
        .build();

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    axum_server::bind(addr)
        .http_config(config)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

pub fn http1_only(&mut self, val: bool) -> &mut Self

Sets whether HTTP1 is required.

Default is false.

Examples found in repository

examples/configure_http.rs (line 14)

↕

fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let config = HttpConfig::new()
        .http1_only(true)
        .http2_only(false)
        .max_buf_size(8192)
        .build();

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    axum_server::bind(addr)
        .http_config(config)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

pub fn http1_half_close(&mut self, val: bool) -> &mut Self

Set whether HTTP/1 connections should support half-closures.

Clients can chose to shutdown their write-side while waiting for the server to respond. Setting this to true will prevent closing the connection immediately if read detects an EOF in the middle of a request.

Default is false.

pub fn http1_keep_alive(&mut self, val: bool) -> &mut Self

Enables or disables HTTP/1 keep-alive.

Default is true.

pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut Self

Set whether HTTP/1 connections will write header names as title case at the socket level.

Note that this setting does not affect HTTP/2.

Default is false.

pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut Self

Set whether HTTP/1 connections will write header names as provided at the socket level.

Note that this setting does not affect HTTP/2.

Default is false.

pub fn http1_writev(&mut self, val: bool) -> &mut Self

Set whether HTTP/1 connections should try to use vectored writes, or always flatten into a single buffer.

Note that setting this to false may mean more copies of body data, but may also improve performance when an IO transport doesn’t support vectored writes well, such as most TLS implementations.

Setting this to true will force hyper to use queued strategy which may eliminate unnecessary cloning on some TLS backends

Default is auto. In this mode hyper will try to guess which mode to use

pub fn http2_only(&mut self, val: bool) -> &mut Self

Sets whether HTTP2 is required.

Default is false

Examples found in repository

examples/configure_http.rs (line 15)

↕

fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let config = HttpConfig::new()
        .http1_only(true)
        .http2_only(false)
        .max_buf_size(8192)
        .build();

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    axum_server::bind(addr)
        .http_config(config)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

pub fn http2_initial_stream_window_size(
    &mut self,
    sz: impl Into<Option<u32>>
) -> &mut Self

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn http2_initial_connection_window_size(
    &mut self,
    sz: impl Into<Option<u32>>
) -> &mut Self

Sets the max connection-level flow control for HTTP2.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut Self

Sets whether to use an adaptive flow control.

Enabling this will override the limits set in http2_initial_stream_window_size and http2_initial_connection_window_size.

pub fn http2_max_frame_size(&mut self, sz: impl Into<Option<u32>>) -> &mut Self

Sets the maximum frame size to use for HTTP2.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn http2_max_concurrent_streams(
    &mut self,
    max: impl Into<Option<u32>>
) -> &mut Self

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is no limit (std::u32::MAX). Passing None will do nothing.

pub fn http2_keep_alive_interval(
    &mut self,
    interval: impl Into<Option<Duration>>
) -> &mut Self

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Self

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed. Does nothing if http2_keep_alive_interval is disabled.

Default is 20 seconds.

pub fn max_buf_size(&mut self, max: usize) -> &mut Self

Set the maximum buffer size for the connection.

Default is ~400kb.

Panics

The minimum value allowed is 8192. This method panics if the passed max is less than the minimum.

Examples found in repository

examples/configure_http.rs (line 16)

↕

fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let config = HttpConfig::new()
        .http1_only(true)
        .http2_only(false)
        .max_buf_size(8192)
        .build();

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    axum_server::bind(addr)
        .http_config(config)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

pub fn pipeline_flush(&mut self, enabled: bool) -> &mut Self

Aggregates flushes to better support pipelined responses.

Experimental, may have bugs.

Default is false.

Trait Implementations

impl Clone for HttpConfig

fn clone(&self) -> HttpConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpConfig

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

Formats the value using the given formatter.

impl Default for HttpConfig

fn default() -> Self

Returns the “default value” for a type.