Struct Router
pub struct Router<State = ()> { /* private fields */ }Expand description
A basic router that can be used to route requests to different services based on the request path.
This router uses matchit::Router to efficiently match incoming requests
to predefined routes. Each route is associated with an HttpMatcher
and a corresponding service handler.
Implementations§
§impl<State> Router<State>
impl<State> Router<State>
pub fn with_state<T>(self, state: T) -> Router<T>
pub fn with_state<T>(self, state: T) -> Router<T>
Attach state to this router
pub fn get<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn get<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a GET route to the router.
the path can contain parameters, e.g. /users/{id}.
the path can also contain a catch call, e.g. /assets/{*path}.
pub fn post<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn post<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a POST route to the router.
pub fn put<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn put<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a PUT route to the router.
pub fn delete<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn delete<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a DELETE route to the router.
pub fn patch<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn patch<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a PATCH route to the router.
pub fn head<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn head<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a HEAD route to the router.
pub fn options<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn options<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a OPTIONS route to the router.
pub fn trace<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn trace<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a TRACE route to the router.
pub fn connect<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn connect<I, T>(self, path: &str, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a CONNECT route to the router.
pub fn file(
self,
path: &str,
file: impl AsRef<Path>,
mime: Mime,
) -> Router<State>
pub fn file( self, path: &str, file: impl AsRef<Path>, mime: Mime, ) -> Router<State>
serve the given file under the given path.
pub fn dir(self, path: &str, dir: impl AsRef<Path>) -> Router<State>
pub fn dir(self, path: &str, dir: impl AsRef<Path>) -> Router<State>
serve the given directory under the given path.
pub fn dir_with_serve_mode(
self,
path: &str,
dir: impl AsRef<Path>,
mode: DirectoryServeMode,
) -> Router<State>
pub fn dir_with_serve_mode( self, path: &str, dir: impl AsRef<Path>, mode: DirectoryServeMode, ) -> Router<State>
serve the given directory under the given path, with a custom serve move.
pub fn dir_embed(self, path: &str, dir: Dir<'static>) -> Router<State>
pub fn dir_embed(self, path: &str, dir: Dir<'static>) -> Router<State>
serve the given embedded directory under the given path.
pub fn dir_embed_with_serve_mode(
self,
path: &str,
dir: Dir<'static>,
mode: DirectoryServeMode,
) -> Router<State>
pub fn dir_embed_with_serve_mode( self, path: &str, dir: Dir<'static>, mode: DirectoryServeMode, ) -> Router<State>
serve the given embedded directory under the given path with a custom serve move.
pub fn sub(self, prefix: &str, router: Router) -> Router<State>
pub fn sub(self, prefix: &str, router: Router) -> Router<State>
register a nested router under a prefix.
The prefix is used to match the request path and strip it from the request URI.
Note: this sub-router is configured with the same State this router has.
pub fn sub_service<I, T>(self, prefix: &str, service: I) -> Router<State>where
I: IntoEndpointService<T>,
pub fn sub_service<I, T>(self, prefix: &str, service: I) -> Router<State>where
I: IntoEndpointService<T>,
Register a nested service under a prefix.
The prefix is used to match the request path and strip it from the request URI.
Warning: This sub-service has no notion of the state this router has. If you want
to create a sub-router that shares the same state this router has, use Router::sub instead.
pub fn match_route<I, T>(
self,
path: &str,
matcher: HttpMatcher<Body>,
service: I,
) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn match_route<I, T>(
self,
path: &str,
matcher: HttpMatcher<Body>,
service: I,
) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
add a route to the router with it’s matcher and service.
pub fn not_found<I, T>(self, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
pub fn not_found<I, T>(self, service: I) -> Router<State>where
I: IntoEndpointServiceWithState<T, State>,
use the provided service when no route matches the request.
Trait Implementations§
§impl<State> Service<Request> for Router<State>
impl<State> Service<Request> for Router<State>
§type Error = Infallible
type Error = Infallible
The type of error returned by the service.
§async fn serve(
&self,
req: Request,
) -> Result<<Router<State> as Service<Request>>::Response, <Router<State> as Service<Request>>::Error>
async fn serve( &self, req: Request, ) -> Result<<Router<State> as Service<Request>>::Response, <Router<State> as Service<Request>>::Error>
Serve a response or error for the given request,
using the given context.
§fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>
fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>
Box this service to allow for dynamic dispatch.
Auto Trait Implementations§
impl<State = ()> !Freeze for Router<State>
impl<State = ()> !RefUnwindSafe for Router<State>
impl<State> Send for Router<State>where
State: Send,
impl<State> Sync for Router<State>where
State: Sync,
impl<State> Unpin for Router<State>where
State: Unpin,
impl<State = ()> !UnwindSafe for Router<State>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<S, Body> HttpClientExt for S
impl<S, Body> HttpClientExt for S
§type ExecuteResponse = Response<Body>
type ExecuteResponse = Response<Body>
The response type returned by the
execute method.§type ExecuteError = <S as Service<Request>>::Error
type ExecuteError = <S as Service<Request>>::Error
The error type returned by the
execute method.§fn get(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
GET request to a URL. Read more§fn post(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
POST request to a URL. Read more§fn put(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
PUT request to a URL. Read more§fn patch(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
PATCH request to a URL. Read more§fn delete(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
DELETE request to a URL. Read more§fn head(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
HEAD request to a URL. Read more§fn connect(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
Convenience method to make a
CONNECT request to a URL. Read more§fn request(
&self,
method: Method,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
§fn build_from_request<RequestBody>(
&self,
request: Request<RequestBody>,
) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
§fn execute(
&self,
request: Request,
) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>
fn execute( &self, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>
Executes a
Request. Read more§impl<S, Body> HttpClientWebSocketExt<Body> for S
impl<S, Body> HttpClientWebSocketExt<Body> for S
§fn websocket(
&self,
url: impl IntoUrl,
) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
Create a new
WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.§fn websocket_h2(
&self,
url: impl IntoUrl,
) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
Create a new
WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.§fn websocket_with_request<RequestBody>(
&self,
req: Request<RequestBody>,
) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
Create a new
WebSocketRequestBuilder starting from the given request. Read more§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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§impl<S, R> IntoEndpointService<(R,)> for Swhere
S: Service<Request, Response = R, Error = Infallible>,
R: IntoResponse + Send + Sync + 'static,
impl<S, R> IntoEndpointService<(R,)> for Swhere
S: Service<Request, Response = R, Error = Infallible>,
R: IntoResponse + Send + Sync + 'static,
§fn into_endpoint_service(
self,
) -> impl Service<Request, Response = Response, Error = Infallible>
fn into_endpoint_service( self, ) -> impl Service<Request, Response = Response, Error = Infallible>
convert the type into a
rama_core::Service.§impl<S, R, State> IntoEndpointServiceWithState<(R,), State> for Swhere
S: Service<Request, Response = R, Error = Infallible>,
R: IntoResponse + Send + Sync + 'static,
impl<S, R, State> IntoEndpointServiceWithState<(R,), State> for Swhere
S: Service<Request, Response = R, Error = Infallible>,
R: IntoResponse + Send + Sync + 'static,
§fn into_endpoint_service_with_state(
self,
_state: State,
) -> impl Service<Request, Response = Response, Error = Infallible>
fn into_endpoint_service_with_state( self, _state: State, ) -> impl Service<Request, Response = Response, Error = Infallible>
convert the type into a
rama_core::Service with state.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Create a new
Policy that returns Action::Follow only if self and other return
Action::Follow. Read more§impl<T, U> RamaTryFrom<T> for Uwhere
U: TryFrom<T>,
impl<T, U> RamaTryFrom<T> for Uwhere
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>
§impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for Twhere
U: RamaTryFrom<T, CrateMarker>,
impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for Twhere
U: RamaTryFrom<T, CrateMarker>,
type Error = <U as RamaTryFrom<T, CrateMarker>>::Error
fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>
§impl<S, RequestIn, RequestOut> RequestInspector<RequestIn> for S
impl<S, RequestIn, RequestOut> RequestInspector<RequestIn> for S
type RequestOut = RequestOut
§fn inspect_request(
&self,
req: RequestIn,
) -> impl Future<Output = Result<<S as RequestInspector<RequestIn>>::RequestOut, <S as RequestInspector<RequestIn>>::Error>> + Send
fn inspect_request( &self, req: RequestIn, ) -> impl Future<Output = Result<<S as RequestInspector<RequestIn>>::RequestOut, <S as RequestInspector<RequestIn>>::Error>> + Send
Inspect the request, modify it if needed or desired, and return it.