[][src]Struct valor_core::Handler

pub struct Handler<L> { /* fields omitted */ }

The main entry point for dispatching incoming requests to plugins registered under a specific URL prefix.

let handler = Handler::new(())
    .with_plugin("foo", |req: Request| async move { req.url().path().into() });

let mut request = Request::new(Method::Get, "http://example.com/_foo/bar/baz");
request.insert_header("x-request-id", "123");
let mut res = handler.handle_request(request).await.unwrap();

assert_eq!(res.status(), StatusCode::Ok);
assert_eq!(res.header("x-correlation-id").unwrap(), "123");
assert_eq!(res.header("x-valor-plugin").unwrap(), "foo");
assert_eq!(res.body_string().await.unwrap(), "/bar/baz");

Implementations

impl<L: Loader + 'static> Handler<L>[src]

pub fn new(loader: L) -> Self[src]

Creates a new Handler instance

pub async fn load_plugin(&self, plugin: Plugin) -> Result<(), LoadError>[src]

Uses the configured loader to load and register the provided plugin

pub fn with_health(self) -> Self[src]

Include the built-in health plugin that returns Ok on _health

pub fn with_plugin<H>(self, plugin: impl Into<Plugin>, handler: H) -> Self where
    H: RequestHandler + 'static, 
[src]

Adds a plugin with its handler to the internal registry

pub async fn handle_request(
    &self,
    request: impl Into<Request>
) -> Result<Response, Response>
[src]

Handles an incoming request by answering form a plugin that matches the URL pattern

It requires the request to specify a x-request-id header that is set back on the response as x-correlation-id(e.g. used by valor_web to match requests and responses)

Trait Implementations

impl<L> Clone for Handler<L>[src]

Auto Trait Implementations

impl<L> !RefUnwindSafe for Handler<L>[src]

impl<L> !Send for Handler<L>[src]

impl<L> !Sync for Handler<L>[src]

impl<L> Unpin for Handler<L>[src]

impl<L> !UnwindSafe for Handler<L>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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