Struct salvo::Server[][src]

pub struct Server { /* fields omitted */ }

Implementations

impl Server[src]

pub fn new<T>(router: T) -> Server where
    T: Into<Arc<Router>>, 
[src]

Create new Server with router.

pub fn with_catchers<T>(self, catchers: T) -> Server where
    T: Into<Arc<Vec<Box<dyn Catcher + 'static, Global>, Global>>>, 
[src]

Set custom catchers for server.

pub fn with_allowed_media_types<T>(self, allowed_media_types: T) -> Server where
    T: Into<Arc<Vec<Mime, Global>>>, 
[src]

Set allowed media types for server, any media type is not include in this list will not allowed to send to client.

pub async fn bind(self, addr: impl Into<SocketAddr> + 'static)[src]

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>
) -> Result<SocketAddr, Error>
[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 async fn bind_with_graceful_shutdown(
    self,
    addr: impl Into<SocketAddr> + 'static,
    signal: impl Future<Output = ()> + Send + 'static
)
[src]

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 salvo_core::prelude::*;
use tokio::sync::oneshot;

#[fn_handler]
async fn hello_world(res: &mut Response) {
    res.render_plain_text("Hello World!");
}

#[tokio::main]
async fn main() {
    let (tx, rx) = oneshot::channel();
    let router = Router::new().get(hello_world);
    let server = Server::new(router).bind_with_graceful_shutdown(([0, 0, 0, 0], 3131), async {
        rx.await.ok();
    });

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

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

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

Create a server with graceful shutdown signal.

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

pub async fn bind_incoming<I>(self, incoming: I) where
    I: TryStream + Send,
    <I as TryStream>::Ok: AsyncRead,
    <I as TryStream>::Ok: AsyncWrite,
    <I as TryStream>::Ok: Send,
    <I as TryStream>::Ok: 'static,
    <I as TryStream>::Ok: Unpin,
    <I as TryStream>::Error: Into<Box<dyn Error + 'static + Sync + Send, Global>>, 
[src]

Bind to a stream, 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_incoming<I>(self, incoming: I) -> Result<(), Error> where
    I: TryStream + Send,
    <I as TryStream>::Ok: AsyncRead,
    <I as TryStream>::Ok: AsyncWrite,
    <I as TryStream>::Ok: Send,
    <I as TryStream>::Ok: 'static,
    <I as TryStream>::Ok: Unpin,
    <I as TryStream>::Error: Into<Box<dyn Error + 'static + Sync + Send, Global>>, 
[src]

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 async fn bind_incoming_with_graceful_shutdown<I>(
    self,
    incoming: I,
    signal: impl Future<Output = ()> + Send + 'static
) where
    I: TryStream + Send,
    <I as TryStream>::Ok: AsyncRead,
    <I as TryStream>::Ok: AsyncWrite,
    <I as TryStream>::Ok: Send,
    <I as TryStream>::Ok: 'static,
    <I as TryStream>::Ok: Unpin,
    <I as TryStream>::Error: Into<Box<dyn Error + 'static + Sync + Send, Global>>, 
[src]

pub async fn try_bind_incoming_with_graceful_shutdown<I>(
    self,
    incoming: I,
    signal: impl Future<Output = ()> + Send + 'static
) -> Result<(), Error> where
    I: TryStream + Send,
    <I as TryStream>::Ok: AsyncRead,
    <I as TryStream>::Ok: AsyncWrite,
    <I as TryStream>::Ok: Send,
    <I as TryStream>::Ok: 'static,
    <I as TryStream>::Ok: Unpin,
    <I as TryStream>::Error: Into<Box<dyn Error + 'static + Sync + Send, Global>>, 
[src]

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.

pub fn tls(self) -> TlsServer[src]

Configure a server to use TLS.

This function requires the "tls" feature.

Auto Trait Implementations

impl !RefUnwindSafe for Server

impl Send for Server

impl Sync for Server

impl Unpin for Server

impl !UnwindSafe for Server

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,