Struct Server

pub struct Server<F, A, R> { /* private fields */ }

Available on crate feature server and docsrs only.

A warp Server ready to filter requests.

Construct this type using serve().

Unnameable

This type is publicly available in the docs only.

It is not otherwise nameable, since it is a builder type using typestate to allow for ergonomic configuration.

Implementations

impl<F, R> Server<F, LazyTcp, R>

where F: Filter + Clone + Send + Sync + 'static, <F::Future as TryFuture>::Ok: Reply, <F::Future as TryFuture>::Error: IsReject, R: Run,

pub async fn run(self, addr: impl Into<SocketAddr>)

Binds and runs this server.

Panics

Panics if we are unable to bind to the provided address.

To handle bind failures, bind a listener and call incoming().

pub async fn bind( self, addr: impl Into<SocketAddr>, ) -> Server<F, TcpListener, R>

Binds this server.

Panics

Panics if we are unable to bind to the provided address.

To handle bind failures, bind a listener and call incoming().

pub fn incoming<A>(self, acceptor: A) -> Server<F, A, R>

Configure the server with an acceptor of incoming connections.

impl<F, A, R> Server<F, A, R>

where F: Filter + Clone + Send + Sync + 'static, <F::Future as TryFuture>::Ok: Reply, <F::Future as TryFuture>::Error: IsReject, A: Accept, R: Run,

pub fn graceful<Fut>(self, shutdown_signal: Fut) -> Server<F, A, Graceful<Fut>>

where Fut: Future<Output = ()> + Send + 'static,

Add graceful shutdown support to this server.

Example

warp::serve(filter)
    .bind(addr).await
    .graceful(async {
        // some signal in here, such as ctrl_c
    })
    .run().await;

pub async fn run(self)

Run this server.

Trait Implementations

impl<F: Debug, A: Debug, R: Debug> Debug for Server<F, A, R>

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

Formats the value using the given formatter.