Struct Builder

pub struct Builder<E> { /* private fields */ }

Available on crate feature server and (crate features http1 or http2) only.

Http1 or Http2 connection builder.

Implementations

impl<E> Builder<E>

pub fn new(executor: E) -> Self

Create a new auto connection builder.

executor parameter should be a type that implements Executor trait.

Example

use hyper_util::{
    rt::TokioExecutor,
    server::conn::auto,
};

auto::Builder::new(TokioExecutor::new());

pub fn http1(&mut self) -> Http1Builder<'_, E>

Available on crate feature http1 only.

Http1 configuration.

pub fn http2(&mut self) -> Http2Builder<'_, E>

Available on crate feature http2 only.

Http2 configuration.

pub fn http2_only(self) -> Self

Available on crate feature http2 only.

Only accepts HTTP/2

Does not do anything if used with serve_connection_with_upgrades

pub fn http1_only(self) -> Self

Available on crate feature http1 only.

Only accepts HTTP/1

Does not do anything if used with serve_connection_with_upgrades

pub fn is_http1_available(&self) -> bool

Returns true if this builder can serve an HTTP/1.1-based connection.

pub fn is_http2_available(&self) -> bool

Returns true if this builder can serve an HTTP/2-based connection.

pub fn title_case_headers(self, enabled: bool) -> Self

Available on crate feature http1 only.

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

This setting only affects HTTP/1 connections. HTTP/2 connections are not affected by this setting.

Default is false.

Example

use hyper_util::{
    rt::TokioExecutor,
    server::conn::auto,
};

auto::Builder::new(TokioExecutor::new())
    .title_case_headers(true);

pub fn preserve_header_case(self, enabled: bool) -> Self

Available on crate feature http1 only.

Set whether HTTP/1 connections will preserve the original case of header names.

This setting only affects HTTP/1 connections. HTTP/2 connections are not affected by this setting.

Default is false.

Example

use hyper_util::{
    rt::TokioExecutor,
    server::conn::auto,
};

auto::Builder::new(TokioExecutor::new())
    .preserve_header_case(true);

pub fn serve_connection<I, S, B>( &self, io: I, service: S, ) -> Connection<'_, I, S, E>

where S: Service<Request<Incoming>, Response = Response<B>>, S::Future: 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>, B: Body + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>, I: Read + Write + Unpin + 'static, E: HttpServerConnExec<S::Future, B>,

Bind a connection together with a Service.

pub fn serve_connection_with_upgrades<I, S, B>( &self, io: I, service: S, ) -> UpgradeableConnection<'_, I, S, E>

where S: Service<Request<Incoming>, Response = Response<B>>, S::Future: 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>, B: Body + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>, I: Read + Write + Unpin + Send + 'static, E: HttpServerConnExec<S::Future, B>,

Bind a connection together with a Service, with the ability to handle HTTP upgrades. This requires that the IO object implements Send.

Note that if you ever want to use hyper::upgrade::Upgraded::downcast with this crate, you’ll need to use hyper_util::server::conn::auto::upgrade::downcast instead. See the documentation of the latter to understand why.

Trait Implementations

impl<E: Clone> Clone for Builder<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Builder<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for Builder<E>

fn default() -> Self

Returns the “default value” for a type.