pub struct Router { /* private fields */ }Expand description
HTTP Router with Laravel-like route registration
Implementations§
Source§impl Router
impl Router
Sourcepub fn group<F>(self, prefix: &str, builder_fn: F) -> GroupBuilder
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
impl Router
Sourcepub fn get_route_middleware(&self, path: &str) -> Vec<BoxedMiddleware> ⓘ
pub fn get_route_middleware(&self, path: &str) -> Vec<BoxedMiddleware> ⓘ
Get middleware for a specific route path
Sourcepub fn get_fallback(&self) -> Option<(Arc<BoxedHandler>, Vec<BoxedMiddleware>)>
pub fn get_fallback(&self) -> Option<(Arc<BoxedHandler>, Vec<BoxedMiddleware>)>
Get the fallback handler and its middleware
Sourcepub fn get<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
pub fn get<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
Register a GET route
Sourcepub fn post<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
pub fn post<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
Register a POST route
Sourcepub fn put<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
pub fn put<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
Register a PUT route
Sourcepub fn patch<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
pub fn patch<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
Register a PATCH route
Sourcepub fn delete<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
pub fn delete<H, Fut>(self, path: &str, handler: H) -> RouteBuilder
Register a DELETE route
Sourcepub fn match_route(
&self,
method: &Method,
path: &str,
) -> Option<(Arc<BoxedHandler>, HashMap<String, String>, String)>
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 From<GroupBuilder> for Router
impl From<GroupBuilder> for Router
Source§fn from(builder: GroupBuilder) -> Self
fn from(builder: GroupBuilder) -> Self
Source§impl From<RouteBuilder> for Router
impl From<RouteBuilder> for Router
Source§fn from(builder: RouteBuilder) -> Self
fn from(builder: RouteBuilder) -> Self
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> 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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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>
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>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);