Struct hyper::server::conn::Http

pub struct Http<E = Exec> { /* fields omitted */ }

This is supported on crate feature server and (crate features http1 or http2) only.

A lower-level configuration of the HTTP protocol.

This structure is used to configure options for an HTTP server connection.

If you don’t have need to manage connections yourself, consider using the higher-level Server API.

Implementations

impl Http

pub fn new() -> Http

Creates a new instance of the HTTP protocol, ready to spawn a server or start accepting connections.

impl<E> Http<E>

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

This is supported on crate feature http1 only.

Sets whether HTTP1 is required.

Default is false

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

This is supported on crate feature http1 only.

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

This is supported on crate feature http1 only.

Enables or disables HTTP/1 keep-alive.

Default is true.

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

This is supported on crate feature http1 only.

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

This is supported on crate feature http1 only.

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 http2_only(&mut self, val: bool) -> &mut Self

This is supported on crate feature http2 only.

Sets whether HTTP2 is required.

Default is false

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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.

Cargo Feature

Requires the runtime cargo feature to be enabled.

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

This is supported on crate feature http2 only.

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.

Cargo Feature

Requires the runtime cargo feature to be enabled.

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

This is supported on crate feature http1 only.

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.

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

Aggregates flushes to better support pipelined responses.

Experimental, may have bugs.

Default is false.

pub fn with_executor<E2>(self, exec: E2) -> Http<E2>

Set the executor used to spawn background tasks.

Default uses implicit default (like tokio::spawn).

pub fn serve_connection<S, I, Bd>(
    &self,
    io: I,
    service: S
) -> Connection<I, S, E> where
    S: HttpService<Body, ResBody = Bd>,
    S::Error: Into<Box<dyn StdError + Send + Sync>>,
    Bd: HttpBody + 'static,
    Bd::Error: Into<Box<dyn StdError + Send + Sync>>,
    I: AsyncRead + AsyncWrite + Unpin,
    E: ConnStreamExec<S::Future, Bd>, 

Bind a connection together with a Service.

This returns a Future that must be polled in order for HTTP to be driven on the connection.

Example

let http = Http::new();
let conn = http.serve_connection(some_io, some_service);

if let Err(e) = conn.await {
    eprintln!("server connection error: {}", e);
}

Trait Implementations

impl<E: Clone> Clone for Http<E>

fn clone(&self) -> Http<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Http<E>

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

Formats the value using the given formatter.