Struct Service 

#[non_exhaustive]
pub struct Service {
    pub router: Arc<Router>,
    pub catcher: Option<Arc<Catcher>>,
    pub hoops: Vec<Arc<dyn Handler>>,
    pub allowed_media_types: Arc<Vec<Mime>>,
}

Service http request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

router: Arc<Router>

The router of this service.

catcher: Option<Arc<Catcher>>

The catcher of this service.

hoops: Vec<Arc<dyn Handler>>

These hoops will always be called when request received.

allowed_media_types: Arc<Vec<Mime>>

The allowed media types of this service.

Implementations

impl Service

pub fn new<T>(router: T) -> Service

where T: Into<Arc<Router>>,

Create a new Service with a Router.

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

Get router in this Service.

pub fn catcher(self, catcher: impl Into<Arc<Catcher>>) -> Service

When the response code is 400-600 and the body is empty, capture and set the error page content. If catchers is not set, the default error page will be used.

Example

use salvo_core::prelude::*;
use salvo_core::catcher::Catcher;

#[handler]
async fn handle404(&self, _req: &Request, _depot: &Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
    if let Some(StatusCode::NOT_FOUND) = res.status_code {
        res.render("Custom 404 Error Page");
        ctrl.skip_rest();
    }
}

#[tokio::main]
async fn main() {
    Service::new(Router::new()).catcher(Catcher::default().hoop(handle404));
}

pub fn hoop<H>(self, hoop: H) -> Service

where H: Handler,

Add a handler as middleware, it will run the handler when request received.

pub fn hoop_when<H, F>(self, hoop: H, filter: F) -> Service

where H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Add a handler as middleware, it will run the handler when request received.

This middleware is only effective when the filter returns true..

pub fn allowed_media_types<T>(self, allowed_media_types: T) -> Service

where T: Into<Arc<Vec<Mime>>>,

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

Example

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

pub async fn handle(&self, request: impl Into<Request> + Send) -> Response

Handle new request, this function only used for test.

Trait Implementations

impl<T> From<T> for Service

where T: Into<Arc<Router>>,

fn from(router: T) -> Service

Converts to this type from the input type.

impl SendTarget for &Service

async fn call(self, req: Request) -> Response

Send request to target, such as Router, Service, Handler.