Struct HttpServer

pub struct HttpServer<B> { /* private fields */ }

A builder for configuring and listening over HTTP using a Service.

Supported Protocols: HTTP/1, H2, Auto (HTTP/1 + H2)

Implementations

impl HttpServer<Builder>

pub fn http1() -> Self

Create a new http/1.1 Builder with default settings.

pub fn with_guard(self, guard: ShutdownGuard) -> Self

Set the guard that can be used by the HttpServer in case it is turned into an http1 listener.

pub fn maybe_with_guard(self, guard: Option<ShutdownGuard>) -> Self

Maybe set the guard that can be used by the HttpServer in case it is turned into an http1 listener.

pub fn set_guard(&mut self, guard: ShutdownGuard) -> &mut Self

Set the guard that can be used by the HttpServer in case it is turned into an http1 listener.

impl HttpServer<Builder>

pub fn http1_mut(&mut self) -> &mut Http1ConnBuilder

Http1 configuration.

impl HttpServer<Builder>

pub fn h2(exec: Executor) -> Self

Create a new h2 Builder with default settings.

impl HttpServer<Builder>

pub fn h2_mut(&mut self) -> &mut H2ConnBuilder

H2 configuration.

impl HttpServer<Builder>

pub fn auto(exec: Executor) -> Self

Create a new dual http/1.1 + h2 Builder with default settings.

impl HttpServer<Builder>

pub fn http1_mut(&mut self) -> InnerAutoHttp1Builder<'_>

Http1 configuration.

pub fn h2_mut(&mut self) -> InnerAutoHttp2Builder<'_>

H2 configuration.

impl<B> HttpServer<B>

where B: HttpCoreConnServer,

pub fn service<S>(self, service: S) -> HttpService<B, S>

Turn this HttpServer into a Service that can be used to serve IO Byte streams (e.g. a TCP Stream) as HTTP.

pub async fn serve<State, S, Response, IO>( &self, ctx: Context<State>, stream: IO, service: S, ) -> HttpServeResult

where State: Clone + Send + Sync + 'static, S: Service<State, Request, Response = Response, Error = Infallible> + Clone, Response: IntoResponse + Send + 'static, IO: Stream,

Serve a single IO Byte Stream (e.g. a TCP Stream) as HTTP.

pub async fn listen<S, Response, A>( self, addr: A, service: S, ) -> HttpServeResult

where S: Service<(), Request, Response = Response, Error = Infallible>, Response: IntoResponse + Send + 'static, A: ToSocketAddrs,

Listen for connections on the given address, serving HTTP connections.

It’s a shortcut in case you don’t need to operate on the transport layer directly.

pub async fn listen_with_state<State, S, Response, A>( self, state: State, addr: A, service: S, ) -> HttpServeResult

where State: Clone + Send + Sync + 'static, S: Service<State, Request, Response = Response, Error = Infallible>, Response: IntoResponse + Send + 'static, A: ToSocketAddrs,

Listen for connections on the given address, serving HTTP connections.

Same as Self::listen, but including the given state in the Service’s Context.

Trait Implementations

impl<B> Clone for HttpServer<B>

where B: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for HttpServer<B>

where B: Debug,

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

Formats the value using the given formatter.