Struct seamless::api::RouteInfo

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

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

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, though the type information is somewhat related to what the possible types that can be sent and received via JSON.

Types can use the crate::ApiBody macro, or implement crate::api::ApiBody manually in order to describe the shape and documentation that they should hand back.

response_type: ApiBodyInfo

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

Trait Implementations

impl Clone for RouteInfo

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

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

Formats the value using the given formatter.

impl PartialEq<RouteInfo> for RouteInfo

fn eq(&self, other: &RouteInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RouteInfo) -> bool

This method tests for !=.

impl Serialize for RouteInfo

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RouteInfo