Struct HttpServer 

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

Available on crate features http-backend and http and std only.

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

Supported protocols: HTTP/1, H2, Auto (HTTP/1 + H2), and H3 over QUIC.

Implementations

impl HttpServer<Builder>

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

Create a new http/1.1 Builder with default settings.

impl HttpServer<Builder>

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

Http1 configuration.

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

Http1 mutable configuration.

impl HttpServer<Builder>

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

Create a new h2 Builder with default settings.

impl HttpServer<Builder>

pub fn h2(&self) -> &Builder

H2 configuration.

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

H2 mutable 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(&self) -> &Builder

Http1 builder.

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

Http1 mutable builder.

pub fn h2(&self) -> &Builder

H2 builder.

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

H2 mutable builder.

impl<B> HttpServer<B>

where B: HttpCoreConnServer,

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

where S: Clone,

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

where S: Service<Request, Output = Response, Error = !> + Clone, Response: IntoResponse + Send + 'static, IO: Io + ExtensionsRef,

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

pub async fn serve_with_graceful_shutdown<S, Response, IO, F>( &self, stream: IO, service: S, signal: F, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<Request, Output = Response, Error = !> + Clone, Response: IntoResponse + Send + 'static, IO: Io + ExtensionsRef, F: Future<Output = ()> + Send + 'static,

Serve a single IO Byte Stream (e.g. a TCP Stream) as HTTP, and gracefully shut down this connection once signal resolves.

This is in addition to the executor’s graceful shutdown. Useful for connections that should wind down on their own, e.g. a proxy whose upstream went away: h2 sends a GOAWAY, h1 closes after the in-flight response, in both cases without cutting that response.

pub async fn listen<S, Response, A>( self, address: A, service: S, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<Request, Output = Response, Error = !> + Clone, Response: IntoResponse + Send + 'static, A: TryInto<SocketAddress>, <A as TryInto<SocketAddress>>::Error: Into<Box<dyn Error + Sync + Send>>,

Listen for connections on the given SocketAddress, 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, Output = Response, Error = !>, Response: IntoResponse + Send + 'static, P: AsRef<Path>,

Available on target_family=unix only.

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.

impl HttpServer<Config>

pub fn new_http3(exec: Executor) -> HttpServer<Config>

Create an HTTP/3 server for QUIC connections negotiated with the h3 ALPN.

pub fn http3(&self) -> &Config

HTTP/3 connection limits.

pub fn http3_mut(&mut self) -> &mut Config

Mutable HTTP/3 connection limits.

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

where S: Clone,

Turn this server into a service for accepted QUIC connections.

pub async fn serve<S, Response>( &self, connection: Connection, service: S, ) -> Result<(), Box<dyn Error + Sync + Send>>

where S: Service<Request, Output = Response, Error = !> + Clone, Response: IntoResponse + Send + 'static,

Serve a QUIC connection through the ordinary Rama HTTP service interface.

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.

impl Default for HttpServer<Builder>

fn default() -> HttpServer<Builder>

Returns the “default value” for a type.