[−][src]Struct warp::Server
A Warp Server ready to filter requests.
Methods
impl<F> Server<F> where
F: Filter + Clone + Send + Sync + 'static,
<F::Future as TryFuture>::Ok: Reply,
<F::Future as TryFuture>::Error: IsReject,
[src]
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> + 'static)
[src]
Run this Server
forever on the current thread.
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>>,
[src]
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
[src]
self,
addr: impl Into<SocketAddr> + 'static
) -> impl Future<Output = ()> + 'static
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.
pub async fn try_bind(self, addr: impl Into<SocketAddr> + 'static)
[src]
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> + 'static
) -> (SocketAddr, impl Future<Output = ()> + 'static)
[src]
self,
addr: impl Into<SocketAddr> + 'static
) -> (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> + 'static
) -> Result<(SocketAddr, impl Future<Output = ()> + 'static), Error>
[src]
self,
addr: impl Into<SocketAddr> + 'static
) -> 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)
[src]
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 serve_incoming<I>(
self,
incoming: I
) -> impl Future<Output = ()> + 'static where
I: TryStream + Send + 'static,
I::Ok: AsyncRead + AsyncWrite + Send + 'static + Unpin,
I::Error: Into<Box<dyn StdError + Send + Sync>>,
[src]
self,
incoming: I
) -> impl Future<Output = ()> + 'static where
I: TryStream + Send + 'static,
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 any runtime.
pub fn tls(self) -> TlsServer<F>
[src]
Configure a server to use TLS.
This function requires the "tls"
feature.
Trait Implementations
Auto Trait Implementations
impl<F> RefUnwindSafe for Server<F> where
F: RefUnwindSafe,
F: RefUnwindSafe,
impl<F> Send for Server<F> where
F: Send,
F: Send,
impl<F> Sync for Server<F> where
F: Sync,
F: Sync,
impl<F> Unpin for Server<F> where
F: Unpin,
F: Unpin,
impl<F> UnwindSafe for Server<F> where
F: UnwindSafe,
F: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,