Skip to main content

RouteEntry

Struct RouteEntry 

Source
pub struct RouteEntry {
    pub method: HttpMethod,
    pub path: &'static str,
    pub handler_type: &'static str,
    pub rsp_type: &'static str,
    pub summary: &'static str,
    pub description: &'static str,
    pub params: &'static [ParamMeta],
    pub required_role: &'static str,
}
Expand description

A route entry registered at compile time via #[endpoint] (or its shortcuts #[get]/#[post]/…).

Collected by the inventory crate and read at application startup.

Fields§

§method: HttpMethod

HTTP method for this route.

§path: &'static str

Route path pattern (e.g., “/users/{id}”).

§handler_type: &'static str

Type name of the request handler. Used to dispatch to the correct handler at runtime.

§rsp_type: &'static str

OpenAPI response type name (e.g., “UserModel”, “Vec”, “String”).

§summary: &'static str

Human-readable summary for OpenAPI docs (e.g., “Get user by ID”).

§description: &'static str

Optional long-form description from /// doc comments on the impl block.

§params: &'static [ParamMeta]

OpenAPI parameter metadata: path params, body params, etc.

§required_role: &'static str

“” = public, “authenticated” = any valid JWT, otherwise specific role name.

Implementations§

Source§

impl RouteEntry

Source

pub const fn new( method: HttpMethod, path: &'static str, handler_type: &'static str, rsp_type: &'static str, summary: &'static str, description: &'static str, params: &'static [ParamMeta], required_role: &'static str, ) -> Self

Create a new route entry.

Trait Implementations§

Source§

impl Clone for RouteEntry

Source§

fn clone(&self) -> RouteEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Collect for RouteEntry

Source§

impl Debug for RouteEntry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> IClaimsCarrier for T
where T: Send,

Source§

fn set_claims(&mut self, _claims: Option<Box<dyn IClaims>>)

Default no-op. Overridden by inherent set_claims on types that carry claims.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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