Skip to main content

WebServiceAdapter

Struct WebServiceAdapter 

Source
pub struct WebServiceAdapter { /* private fields */ }
Expand description

Create service adapter for a specific path.

use std::convert::Infallible;
use ntex::web::{self, guard, App, HttpResponse};

async fn my_service(req: web::WebRequest<()>) -> Result<web::WebResponse, Infallible> {
    Ok(req.into_response(HttpResponse::Ok().build()))
}

let app = App::default().service(
    web::service("/users/*")
        .guard(guard::Header("content-type", "text/plain"))
        .build(my_service)
);

Implementations§

Source§

impl WebServiceAdapter

Source

pub fn new<T: IntoPattern>(path: T) -> Self

Create new WebServiceAdapter instance.

Source

pub fn name(self, name: &str) -> Self

Set service name.

Name is used for url generation.

Source

pub fn guard<G: Guard + 'static>(self, guard: G) -> Self

Add a match guard to this web service.

The service is selected only when its path and all registered guards match. If a guard rejects the request, the router can try another matching service; otherwise the containing scope or application fallback is used.

use std::convert::Infallible;
use ntex::web::{self, guard, App, HttpResponse};

async fn index(
    req: web::WebRequest<()>,
) -> Result<web::WebResponse, Infallible> {
    Ok(req.into_response(HttpResponse::Ok().build()))
}

App::default().service(
    web::service("/health")
        .guard(guard::Get())
        .guard(guard::Header("x-health-check", "true"))
        .build(index)
);
Source

pub fn build<Sf, St, In, F>(self, service: F) -> impl WebServiceFactory<St, In>
where St: State, In: 'static, F: IntoServiceFactory<Sf, St, WebRequest<In>>, Sf: ServiceFactory<St, WebRequest<In>, Res = WebResponse> + 'static, Sf::Error: WebResponseError<St, St::Error>, Sf::InitError: IntoFailure,

Set a service factory implementation and generate web service.

Trait Implementations§

Source§

impl Debug for WebServiceAdapter

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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<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, 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.