pub struct Routes { /* private fields */ }Expand description
A native Axum router together with a small, explicit route inventory.
Implementations§
Source§impl Routes
impl Routes
Sourcepub fn get<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
pub fn get<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
Register a GET handler (and Axum’s implicit HEAD handler).
Sourcepub fn post<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
pub fn post<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
Register a POST handler.
Sourcepub fn put<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
pub fn put<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
Register a PUT handler.
Sourcepub fn patch<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
pub fn patch<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
Register a PATCH handler.
Sourcepub fn delete<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
pub fn delete<H, T>(self, path: &str, handler: H) -> Routeswhere
H: Handler<T, AppContext>,
T: 'static,
Register a DELETE handler.
Sourcepub fn operation(self, id: impl Into<String>) -> Routes
pub fn operation(self, id: impl Into<String>) -> Routes
Give the preceding route a stable, unique API operation identifier. Handlers are not introspected; describe their actual JSON wire types explicitly.
Sourcepub fn response<T>(self) -> Routeswhere
T: JsonSchema,
pub fn response<T>(self) -> Routeswhere
T: JsonSchema,
Describe the preceding route’s JSON 200 response using serialization semantics.
Sourcepub fn created<T>(self) -> Routeswhere
T: JsonSchema,
pub fn created<T>(self) -> Routeswhere
T: JsonSchema,
Describe the preceding route’s JSON 201 response.
Sourcepub fn response_status<T>(self, status: u16) -> Routeswhere
T: JsonSchema,
pub fn response_status<T>(self, status: u16) -> Routeswhere
T: JsonSchema,
Describe another successful JSON status. Use no_content for HTTP 204.
Sourcepub fn no_content(self) -> Routes
pub fn no_content(self) -> Routes
Describe HTTP 204 with no response body.
Sourcepub fn body<T>(self) -> Routeswhere
T: JsonSchema,
pub fn body<T>(self) -> Routeswhere
T: JsonSchema,
Describe a required Json<T> or Validated<T> body using deserialization semantics.
Adds the extractor’s 400, 413, 415 and 422 error responses.
Sourcepub fn query<T>(self) -> Routeswhere
T: JsonSchema,
pub fn query<T>(self) -> Routeswhere
T: JsonSchema,
Describe a flat query DTO, including Serde defaults and validation constraints. Adds the query extractor’s 400 error response.
Sourcepub fn path<T>(self, name: impl Into<String>) -> Routeswhere
T: JsonSchema,
pub fn path<T>(self, name: impl Into<String>) -> Routeswhere
T: JsonSchema,
Describe one named path parameter’s wire type. Repeat for multiple parameters. Adds the path extractor’s 400 error response.
Sourcepub fn authenticated(self) -> Routes
pub fn authenticated(self) -> Routes
Declare session authentication on the preceding operation and add its 401 response. This is contract metadata; enforce identity with the AuthUser extractor.
Sourcepub fn error(self, status: u16) -> Routes
pub fn error(self, status: u16) -> Routes
Add a meaningful application error response using Capy’s common envelope.
Sourcepub fn error_response<T>(self, status: u16) -> Routeswhere
T: JsonSchema,
pub fn error_response<T>(self, status: u16) -> Routeswhere
T: JsonSchema,
Describe a custom JSON error envelope, for example readiness HTTP 503.
Sourcepub fn tag(self, tag: impl Into<String>) -> Routes
pub fn tag(self, tag: impl Into<String>) -> Routes
Group the preceding operation in API documentation.
Sourcepub fn summary(self, summary: impl Into<String>) -> Routes
pub fn summary(self, summary: impl Into<String>) -> Routes
Add a short summary to the preceding operation.
Sourcepub fn description(self, description: impl Into<String>) -> Routes
pub fn description(self, description: impl Into<String>) -> Routes
Add an optional Markdown description to the preceding operation.
Sourcepub fn api_inventory(&self) -> Vec<ApiRouteInfo>
pub fn api_inventory(&self) -> Vec<ApiRouteInfo>
Return explicitly registered API metadata without opening a database connection.
Sourcepub fn map_router(
self,
map: impl FnOnce(Router<AppContext>) -> Router<AppContext>,
) -> Routes
pub fn map_router( self, map: impl FnOnce(Router<AppContext>) -> Router<AppContext>, ) -> Routes
Access Axum directly for middleware, nesting, and other native features. Routes added here are not included in Capy’s route inventory.
Sourcepub fn into_router(self) -> Router<AppContext>
pub fn into_router(self) -> Router<AppContext>
Consume this wrapper and return the native Axum router, awaiting state.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Routes
impl !UnwindSafe for Routes
impl Freeze for Routes
impl Send for Routes
impl Sync for Routes
impl Unpin for Routes
impl UnsafeUnpin for Routes
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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);