Struct WebContext

Source
pub struct WebContext;
Expand description

middleware for bridging xitca-http and xitca-web types. useful for utilizing xitca-web when manually constructing http services.

§Examples

use xitca_http::util::{
    middleware::context::ContextBuilder,
    service::{handler::handler_service, route::get, Router}
};
use xitca_service::{Service, ServiceExt};
use xitca_web::{error::Error, handler::state::StateRef};

// handler function depending on xitca-web types.
async fn handler(StateRef(_): StateRef<'_, ()>) -> Error {
    xitca_web::error::ErrorStatus::bad_request().into()
}

// low level router from xitca-http
let router = Router::new()
    // utilize handler function with xitca-web types
    .insert("/", get(handler_service(handler)))
    // utilize xitca-web's middleware to xitca-http's router
    .enclosed(xitca_web::middleware::CatchUnwind)
    // converting xitca-http types to xitca-web types with web context middleware.
    .enclosed(xitca_web::middleware::WebContext)
    // xitca-http's context builder middleware is also needed for helping type conversion.
    // this middleware is tasked with constructing typed application state and pass down it
    // to xitca_web's WebContext middleware. In case of absence of application state a tuple
    // is constructed to act as the default type.
    .enclosed(ContextBuilder::new(|| async { Ok::<_, std::convert::Infallible>(()) }));

// call the router service and observe the output. in real world the service caller should be a http
// library and server.
let res = router
    .call(())
    .await
    .unwrap()
    .call(Default::default())
    .await
    .unwrap();

assert_eq!(res.status(), xitca_http::http::StatusCode::BAD_REQUEST);

Trait Implementations§

Source§

impl<S, E> Service<Result<S, E>> for WebContext

Source§

type Response = WebContextService<S>

The Ok part of output future.
Source§

type Error = E

The Err part of output future.
Source§

async fn call(&self, res: Result<S, E>) -> Result<Self::Response, Self::Error>

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> BorrowState<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

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

Source§

type Output = T

Should always be Self
Source§

impl<S, Arg> ServiceExt<Arg> for S
where S: Service<Arg>,

Source§

fn enclosed<T>(self, build: T) -> Pipeline<Self, T, BuildEnclosed>
where T: Service<Result<Self::Response, Self::Error>>, Self: Sized,

Enclose Self with given T as Service<<Self as Service<_>>::Response>>. In other word T would take Self’s Service::Response type as it’s generic argument of Service<_> impl.
Source§

fn enclosed_fn<T, Req, O>( self, func: T, ) -> Pipeline<Self, AsyncFn<T>, BuildEnclosed>
where T: AsyncFn(&Self::Response, Req) -> O + Clone, Self: Sized,

Function version of Self::enclosed method.
Source§

fn map<F, Res, ResMap>(self, mapper: F) -> Pipeline<Self, Map<F>, BuildEnclosed>
where F: Fn(Res) -> ResMap + Clone, Self: Sized,

Mutate <<Self::Response as Service<Req>>::Future as Future>::Output type with given closure.
Source§

fn map_err<F, Err, ErrMap>( self, err: F, ) -> Pipeline<Self, MapErr<F>, BuildEnclosed>
where F: Fn(Err) -> ErrMap + Clone, Self: Sized,

Mutate <Self::Response as Service<Req>>::Error type with given closure.
Source§

fn and_then<F>(self, factory: F) -> Pipeline<Self, F, BuildAndThen>
where F: Service<Arg>, Self: Sized,

Chain another service factory who’s service takes Self’s Service::Response output as Service::Request.
Source§

impl<S, Req> ServiceObject<Req> for S
where S: Service<Req>,

Source§

type Response = <S as Service<Req>>::Response

Source§

type Error = <S as Service<Req>>::Error

Source§

fn call<'s>( &'s self, req: Req, ) -> Pin<Box<dyn Future<Output = Result<<S as ServiceObject<Req>>::Response, <S as ServiceObject<Req>>::Error>> + 's>>
where Req: 's,

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