Trait Request

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

    const METHOD: Method = Method::GET;

    // Required method
    fn endpoint(&self) -> Cow<'_, str>;

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

A RING API request.

Provided Associated Constants

const METHOD: Method = Method::GET

The HTTP method (“verb”) for the request.

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

Required Methods

fn endpoint(&self) -> Cow<'_, str>

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

Provided Methods

fn headers(&self) -> HeaderMap

Additional headers for this request.

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

The body of the request, if any

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.

Implementations on Foreign Types

impl<R: Request> Request for &R

const METHOD: Method = R::METHOD

type Body = <R as Request>::Body

type Response = <R as Request>::Response

fn endpoint(&self) -> Cow<'_, str>

fn headers(&self) -> HeaderMap

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

impl<R: Request> Request for &mut R

const METHOD: Method = R::METHOD

type Body = <R as Request>::Body

type Response = <R as Request>::Response

fn endpoint(&self) -> Cow<'_, str>

fn headers(&self) -> HeaderMap

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

Implementors

impl Request for RetrieveResult

type Body = ()

type Response = RetrieveResultResponse

impl Request for Status

type Body = ()

type Response = StatusResponse

impl Request for SubmitId

const METHOD: Method = Method::POST

type Body = SubmitId

type Response = SubmitResponse

impl Request for SubmitStructure

const METHOD: Method = Method::POST

type Body = SubmitStructure

type Response = SubmitResponse