Skip to main content

RouteDef

Struct RouteDef 

Source
pub struct RouteDef {
    pub pattern: &'static str,
    pub handler_id: &'static str,
    pub handler: &'static str,
    pub verb: &'static [Verb],
    pub params: &'static [ParamDef],
    pub doc: Option<&'static str>,
}
Expand description

The compile-time description of one route in a controller, recorded by the routes! macro. The framework matches and dispatches against these, and tools can introspect them (e.g. the OpenAPI generator).

Fields§

§pattern: &'static str

The route pattern relative to the controller’s mount (e.g. "posts/{id}").

§handler_id: &'static str

Internal dispatch token ("handler_0", "handler_1", …) produced by the #[controller] macro. Opaque to user code; for the human-readable handler method name (useful for OpenAPI operationIds and the like), see RouteDef::handler.

§handler: &'static str

Handler method name as written in the controller’s impl block ("list", "get", "create", …). Captured at macro-expansion time so introspection tools (OpenAPI doc generators, route audit scripts) can identify the handler without grepping.

§verb: &'static [Verb]

Verbs this route accepts. Always non-empty: a single-element slice for an explicitly declared verb, DEFAULT_VERBS for an unmarked route.

§params: &'static [ParamDef]

The route’s declared parameters, in order.

§doc: Option<&'static str>

The handler method’s /// doc comment, if any — surfaced to tools like the OpenAPI generator.

Trait Implementations§

Source§

impl Clone for RouteDef

Source§

fn clone(&self) -> RouteDef

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 Debug for RouteDef

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> 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