Struct rweb::Server [−][src]
pub struct Server<F> { /* fields omitted */ }
Expand description
A Warp Server ready to filter requests.
Implementations
Run this Server
forever on the current thread.
pub async fn run_incoming<I>(self, incoming: I) where
I: TryStream + Send,
<I as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
pub async fn run_incoming<I>(self, incoming: I) where
I: TryStream + Send,
<I as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
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.
Bind to a socket address, returning a Future
that can be
executed on any runtime.
Panics
Panics if we are unable to bind to the provided address.
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)
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
any 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>
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
any runtime.
pub fn bind_with_graceful_shutdown(
self,
addr: impl Into<SocketAddr> + 'static,
signal: impl Future<Output = ()> + Send + 'static
) -> (SocketAddr, impl Future<Output = ()> + 'static)
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
any runtime.
Example
use warp::Filter;
use futures::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(());
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>
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 as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
pub fn serve_incoming<I>(self, incoming: I) -> impl Future<Output = ()> where
I: TryStream + Send,
<I as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
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 any 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 as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
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 as TryStream>::Ok: 'static,
<I as TryStream>::Ok: AsyncRead,
<I as TryStream>::Ok: AsyncWrite,
<I as TryStream>::Ok: Send,
<I as TryStream>::Ok: Unpin,
<I as TryStream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
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 any runtime.
Trait Implementations
Auto Trait Implementations
impl<F> RefUnwindSafe for Server<F> where
F: RefUnwindSafe,
impl<F> UnwindSafe for Server<F> where
F: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub fn vzip(self) -> V
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more