Struct salvo::prelude::Service

pub struct Service { /* private fields */ }

Service http request.

Implementations

impl Service

pub fn new<T>(router: T) -> Servicewhere
    T: Into<Arc<Router>>,

Create a new Service with a Router.

pub fn router(&self) -> Arc<Router>

Get router in this Service.

pub fn with_catchers<T>(self, catchers: T) -> Servicewhere
    T: Into<Arc<Vec<Box<dyn Catcher + 'static, Global>, Global>>>,

When the response code is 400-600 and the body is empty, capture and set the return value. If catchers is not set, the default CatcherImpl will be used.

Example

struct Handle404;
impl Catcher for Handle404 {
    fn catch(&self, _req: &Request, _depot: &Depot, res: &mut Response) -> bool {
        if let Some(StatusCode::NOT_FOUND) = res.status_code() {
            res.render("Custom 404 Error Page");
            true
        } else {
            false
        }
    }
}

#[tokio::main]
async fn main() {
    let catchers: Vec<Box<dyn Catcher>> = vec![Box::new(Handle404)];
    Service::new(Router::new()).with_catchers(catchers);
}

pub fn catchers(&self) -> Arc<Vec<Box<dyn Catcher + 'static, Global>, Global>>

Get catchers list.

pub fn with_allowed_media_types<T>(self, allowed_media_types: T) -> Servicewhere
    T: Into<Arc<Vec<Mime, Global>>>,

Sets allowed media types list and returns Self for write code chained.

Example

let service = Service::new(Router::new()).with_allowed_media_types(vec![mime::TEXT_PLAIN]);

pub fn allowed_media_types(&self) -> Arc<Vec<Mime, Global>>

Get allowed media types list.

pub async fn handle(
    &self,
    request: impl Into<Request>
) -> impl Future<Output = Response>

Handle Request and returns Response.

This function is useful for testing application.

Example

use salvo_core::prelude::*;
use salvo_core::test::{ResponseExt, TestClient};

#[handler]
async fn hello_world() -> &'static str {
    "Hello World"
}
#[tokio::main]
async fn main() {
    let service: Service = Router::new().get(hello_world).into();
    let mut res = TestClient::get("http://127.0.0.1:7878").send(&service).await;
    assert_eq!(res.take_string().await.unwrap(), "Hello World");
}

Trait Implementations

impl<T> From<T> for Servicewhere
    T: Into<Arc<Router>>,

fn from(router: T) -> Service

Converts to this type from the input type.

impl<'t, T> Service<&'t T> for Servicewhere
    T: Transport,

type Response = HyperHandler

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Ready<Result<<Service as Service<&'t T>>::Response, <Service as Service<&'t T>>::Error>>

The future response value.

fn poll_ready(
    &mut self,
    _cx: &mut Context<'_>
) -> Poll<Result<(), <Service as Service<&'t T>>::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, target: &T) -> <Service as Service<&'t T>>::Future

Process the request and return the response asynchronously.