Struct seamless::router::RouteInfo

pub struct RouteInfo {
    pub name: String,
    pub method: String,
    pub description: String,
    pub request_type: ApiBodyType,
    pub response_type: ApiBodyType,
}

Information about a single route.

Fields

name: String

The name/path that the http::Request needs to contain in order to match this route.

method: String

The HTTP method expected in order for a http::Request to match this route, as a string.

description: String

The description of the route as set by RouteBuilder::description()

request_type: ApiBodyType

The shape of the data expected to be provided as part of the http::Request for this route. This doesn't care about the wire format that the data is provided in (be is JSON or other).

If the handler function for the route asks for something of type Json<T>, then the data will be expected to be provided as JSON. However, it is up to the type that implements Body to decide on the expected wire format.

response_type: ApiBodyType

The shape of the data that is returned from this API route.

Trait Implementations

impl Clone for RouteInfo

pub fn clone(&self) -> RouteInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteInfo

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

Formats the value using the given formatter.

impl Serialize for RouteInfo

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.