Struct warp::Server

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

A Warp Server ready to filter requests.

Implementations

impl<F> Server<F>

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

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

Run this Server forever on the current thread.

Panics

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

pub async fn run_incoming<I>(self, incoming: I)

where I: TryStream + Send, I::Ok: AsyncRead + AsyncWrite + Send + 'static + Unpin, I::Error: Into<Box<dyn StdError + Send + Sync>>,

Run this Server forever on the current thread with a specific stream of incoming connections.

This can be used for Unix Domain Sockets, or TLS, etc.

pub fn bind( self, addr: impl Into<SocketAddr> + 'static, ) -> impl Future<Output = ()> + 'static

Bind to a socket address, returning a Future that can be executed on the current runtime.

Panics

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

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

Bind to a socket address, returning a Future that can be executed on any runtime.

In case we are unable to bind to the specified address, resolves to an error and logs the reason.

pub fn bind_ephemeral( self, addr: impl Into<SocketAddr>, ) -> (SocketAddr, impl Future<Output = ()> + 'static)

Bind to a possibly ephemeral socket address.

Returns the bound address and a Future that can be executed on the current runtime.

Panics

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

pub fn try_bind_ephemeral( self, addr: impl Into<SocketAddr>, ) -> Result<(SocketAddr, impl Future<Output = ()> + 'static), Error>

Tried to bind a possibly ephemeral socket address.

Returns a Result which fails in case we are unable to bind with the underlying error.

Returns the bound address and a Future that can be executed on the current runtime.

pub fn bind_with_graceful_shutdown( self, addr: impl Into<SocketAddr> + 'static, signal: impl Future<Output = ()> + Send + 'static, ) -> (SocketAddr, impl Future<Output = ()> + 'static)

Create a server with graceful shutdown signal.

When the signal completes, the server will start the graceful shutdown process.

Returns the bound address and a Future that can be executed on the current runtime.

Example

use warp::Filter;
use futures_util::future::TryFutureExt;
use tokio::sync::oneshot;

let routes = warp::any()
    .map(|| "Hello, World!");

let (tx, rx) = oneshot::channel();

let (addr, server) = warp::serve(routes)
    .bind_with_graceful_shutdown(([127, 0, 0, 1], 3030), async {
         rx.await.ok();
    });

// Spawn the server into a runtime
tokio::task::spawn(server);

// Later, start the shutdown...
let _ = tx.send(());

Panics

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

pub fn try_bind_with_graceful_shutdown( self, addr: impl Into<SocketAddr> + 'static, signal: impl Future<Output = ()> + Send + 'static, ) -> Result<(SocketAddr, impl Future<Output = ()> + 'static), Error>

Create a server with graceful shutdown signal.

When the signal completes, the server will start the graceful shutdown process.

pub fn serve_incoming<I>(self, incoming: I) -> impl Future<Output = ()>

where I: TryStream + Send, I::Ok: AsyncRead + AsyncWrite + Send + 'static + Unpin, I::Error: Into<Box<dyn StdError + Send + Sync>>,

Setup this Server with a specific stream of incoming connections.

This can be used for Unix Domain Sockets, or TLS, etc.

Returns a Future that can be executed on the current runtime.

pub fn serve_incoming_with_graceful_shutdown<I>( self, incoming: I, signal: impl Future<Output = ()> + Send + 'static, ) -> impl Future<Output = ()>

where I: TryStream + Send, I::Ok: AsyncRead + AsyncWrite + Send + 'static + Unpin, I::Error: Into<Box<dyn StdError + Send + Sync>>,

Setup this Server with a specific stream of incoming connections and a signal to initiate graceful shutdown.

This can be used for Unix Domain Sockets, or TLS, etc.

When the signal completes, the server will start the graceful shutdown process.

Returns a Future that can be executed on the current runtime.

Trait Implementations

impl<F: Debug> Debug for Server<F>

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

Formats the value using the given formatter.