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() -> HttpServer<Builder>

Create a new http/1.1 Builder with default settings.

pub fn with_guard(self, guard: ShutdownGuard) -> HttpServer<Builder>

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>, ) -> HttpServer<Builder>

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 HttpServer<Builder>

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 Builder

Http1 configuration.

impl HttpServer<Builder>

pub fn h2(exec: Executor) -> HttpServer<Builder>

Create a new h2 Builder with default settings.

impl HttpServer<Builder>

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

H2 configuration.

impl HttpServer<Builder>

pub fn auto(exec: Executor) -> HttpServer<Builder>

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

impl HttpServer<Builder>

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

Http1 configuration.

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

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<S, Response, IO>( &self, ctx: Context, stream: IO, service: S, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<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, I>( self, interface: I, service: S, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<Request, Response = Response, Error = Infallible>, Response: IntoResponse + Send + 'static, I: TryInto<Interface>, <I as TryInto<Interface>>::Error: Into<Box<dyn Error + Sync + Send>>,

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

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

pub async fn listen_unix<S, Response, P>( self, path: P, service: S, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<Request, Response = Response, Error = Infallible>, Response: IntoResponse + Send + 'static, P: AsRef<Path>,

Listen for connections on the given Path, using a unix (domain) socket, serving HTTP connections.

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

Trait Implementations

impl<B> Clone for HttpServer<B>

where B: Clone,

fn clone(&self) -> HttpServer<B>

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.