Struct saphir::router::Builder

source ·
pub struct Builder<Chain: RouterChain + Send + Unpin + 'static + Sync> { /* private fields */ }
Expand description

Builder type for the router

Implementations§

source§

impl<Controllers: 'static + RouterChain + Unpin + Send + Sync> Builder<Controllers>

source

pub fn route<H>(self, route: &str, method: Method, handler: H) -> Selfwhere H: 'static + DynHandler<Body> + Send + Sync,

Add a simple request handle to a given path

// Simply declare a handler fn
async fn simple_handler(req: Request<Body>) -> impl Responder {200}

// Then while building your server
// ...
builder.route("/simple", Method::GET, simple_handler);
// ...
source

pub fn route_with_guards<H, F, Chain>( self, route: &str, method: Method, handler: H, guards: F ) -> Selfwhere H: 'static + DynHandler<Body> + Send + Sync, F: FnOnce(GuardBuilder<GuardChainEnd>) -> GuardBuilder<Chain>, Chain: GuardChain + 'static,

Add a request handler to a given path behind guards


async fn handler(req: Request<Body>) -> impl Responder { 200 }

async fn value_guard(req: Request<Body>) -> Result<Request<Body>, u16> {
   match req.captures().get("value") {
       Some(v) if v.eq("allowed_value") => Ok(req),
       Some(_) => Err(403),
       None => Err(400),
   }
}

builder.route_with_guards("/handler/{value}", Method::GET, handler, |g| {
    g.apply(value_guard)
});
// ...
source

pub fn controller<C: Controller + Send + Unpin + Sync>( self, controller: C ) -> Builder<RouterChainLink<C, Controllers>>

Add a simple request handle to a given path

// Implement controller for your struct
struct SimpleController;
// Then while building your server
// ...
builder.controller(SimpleController);
// ...

Auto Trait Implementations§

§

impl<Chain> RefUnwindSafe for Builder<Chain>where Chain: RefUnwindSafe,

§

impl<Chain> Send for Builder<Chain>

§

impl<Chain> Sync for Builder<Chain>

§

impl<Chain> Unpin for Builder<Chain>

§

impl<Chain> UnwindSafe for Builder<Chain>where Chain: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere U: From<T>,

const: unstable · 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
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