Struct salvo_core::Service

source ·
#[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>>, }
Expand description

Service http request.

Fields (Non-exhaustive)§

This struct is marked as 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 alwways be called when request received.

§allowed_media_types: Arc<Vec<Mime>>

The allowed media types of this service.

Implementations§

source§

impl Service

source

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

Create a new Service with a Router.

source

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

Get router in this Service.

source

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

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

#[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));
}
source

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

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

source

pub fn hoop_when<H, F>(self, hoop: H, filter: F) -> Self
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 only effective when the filter return true.

source

pub fn allowed_media_types<T>(self, allowed_media_types: T) -> Self
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]);
source

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

Handle new request, this function only used for test.

Trait Implementations§

source§

impl<T> From<T> for Service
where T: Into<Arc<Router>>,

source§

fn from(router: T) -> Self

Converts to this type from the input type.
source§

impl SendTarget for &Service

Available on crate feature test only.
source§

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

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more