Skip to main content

Router

Struct Router 

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

HTTP Router with Laravel-like route registration

Implementations§

Source§

impl Router

Source

pub fn group<F>(self, prefix: &str, builder_fn: F) -> GroupBuilder

Create a route group with a shared prefix

Routes defined within the group will have the prefix prepended to their paths. Middleware applied to the group will be applied to all routes within it.

§Example
Router::new()
    .group("/api", |r| {
        r.get("/users", list_users)      // -> GET /api/users
         .post("/users", create_user)    // -> POST /api/users
         .get("/users/{id}", show_user)  // -> GET /api/users/{id}
    })
    .middleware(ApiMiddleware)
Source§

impl Router

Source

pub fn new() -> Self

Source

pub fn get_route_middleware(&self, path: &str) -> Vec<BoxedMiddleware>

Get middleware for a specific route path

Source

pub fn get_fallback(&self) -> Option<(Arc<BoxedHandler>, Vec<BoxedMiddleware>)>

Get the fallback handler and its middleware

Source

pub fn get<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a GET route

Source

pub fn post<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a POST route

Source

pub fn put<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a PUT route

Source

pub fn patch<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a PATCH route

Source

pub fn delete<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a DELETE route

Source

pub fn match_route( &self, method: &Method, path: &str, ) -> Option<(Arc<BoxedHandler>, HashMap<String, String>, String)>

Match a request and return the handler with extracted params and route pattern

Returns (handler, params, route_pattern) where route_pattern is the original pattern like “/users/{id}” for metrics grouping.

Trait Implementations§

Source§

impl Default for Router

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<GroupBuilder> for Router

Source§

fn from(builder: GroupBuilder) -> Self

Converts to this type from the input type.
Source§

impl From<RouteBuilder> for Router

Source§

fn from(builder: RouteBuilder) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !Freeze for Router

§

impl !RefUnwindSafe for Router

§

impl Send for Router

§

impl Sync for Router

§

impl Unpin for Router

§

impl UnsafeUnpin for Router

§

impl !UnwindSafe for Router

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> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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