Trait ring_api::requests::Request

pub trait Request {
    type Body: Serialize;
    type Response: for<'de> Deserialize<'de>;

    const METHOD: Method;

    fn endpoint(&self) -> Cow<str>;

    fn headers(&self) -> HeaderMap { ... }
    fn body(&self) -> RequestBody<&Self::Body> { ... }
}

A RING API request.

Associated Types

type Body: Serialize

The type of the body for this request. TODO(H2CO3): default to ().

type Response: for<'de> Deserialize<'de>

The "return type" of the request.

Loading content...

Associated Constants

const METHOD: Method

The HTTP method ("verb") for the request.

Loading content...

Required methods

fn endpoint(&self) -> Cow<str>

The endpoint: the part of the URL/path that follows the base URL.

Loading content...

Provided methods

fn headers(&self) -> HeaderMap

Additional headers for this request.

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

The body of the request, if any

Loading content...

Implementations on Foreign Types

impl<'_, R: Request> Request for &'_ R

type Body = R::Body

type Response = R::Response

const METHOD: Method

fn endpoint(&self) -> Cow<str>

fn headers(&self) -> HeaderMap

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

impl<'_, R: Request> Request for &'_ mut R

type Body = R::Body

type Response = R::Response

const METHOD: Method

fn endpoint(&self) -> Cow<str>

fn headers(&self) -> HeaderMap

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

Loading content...

Implementors

impl Request for RetrieveResult

type Body = ()

type Response = RetrieveResultResponse

fn endpoint(&self) -> Cow<str>

impl Request for Status

type Body = ()

type Response = StatusResponse

fn endpoint(&self) -> Cow<str>

impl Request for SubmitId

type Body = Self

type Response = SubmitResponse

const METHOD: Method

fn endpoint(&self) -> Cow<str>

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

impl Request for SubmitStructure

type Body = Self

type Response = SubmitResponse

const METHOD: Method

fn endpoint(&self) -> Cow<str>

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

Loading content...