Trait Api

pub trait Api {
    type Reply;
    type Body: Read;
    type Error;

    // Required methods
    fn method(&self) -> Method;
    fn path(&self) -> String;
    fn query(&self) -> Query<'_>;
    fn headers(&self) -> Headers;
    fn body(&self) -> Self::Body;
    fn parse<Resp>(&self, _: &mut Resp) -> Result<Self::Reply, Self::Error>
       where Resp: HttpResponse;
}

Api represents a HTTP API exposing all the request parameters and a function to parse the HTTP response.

Required Associated Types

type Reply

type Body: Read

type Error

Required Methods

fn method(&self) -> Method

Return the HTTP method used by this API.

fn path(&self) -> String

Return the URL path for this API request.

fn query(&self) -> Query<'_>

Return the URL query for this API request.

fn headers(&self) -> Headers

Return the headers for this HTTP request.

fn body(&self) -> Self::Body

Return the body of this HTTP request. If the request doesn’t expect any body (i.e. GET), it should return std::io::Empty.

fn parse<Resp>(&self, _: &mut Resp) -> Result<Self::Reply, Self::Error>

where Resp: HttpResponse,

Parse the HTTP response, received from the actual client, into the type Reply.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors