Struct Request

pub struct Request<P, O, M>
where
    P: Payload,
{ /* private fields */ }

A request to the API, wrapping the payload into a future.

Create from a ApiCaller and a Payload.

Example

use api_req::{Payload, ApiCaller, Method, ApiCaller as _};
use serde::{Serialize, Deserialize};

#[derive(Debug, Default, Clone, Serialize, Payload)]
#[api_req(
    path = "/payments/{customer_id}",   // customer_id from struct field
    method = Method::POST,
)]
pub struct ExamplePayload {
    #[serde(skip_serializing)]
    customer_id: String,
    amount: usize,
}

#[derive(Debug, Deserialize)]
struct ExampleResponse {
    client_secret: String,
}

#[derive(ApiCaller)]
#[api_req(base_url = "http://example.com")]
struct ExampleApi;
let payload = ExamplePayload::default();
let _resp: ExampleResponse = ExampleApi::request(payload).await.unwrap();
// this will send a POST request to http://example.com/payments/{customer_id}
// with json `{"amount": 100}`

Implementations

impl<P, O, M> Request<P, O, M>

where P: Payload,

pub fn new(payload: P, base_url: String, client: Client) -> Self

Create a new request

Trait Implementations

impl<P> Future for Request<P, RespStream, ((),)>

where P: Payload,

Available on crate feature stream only.

type Output = Result<Box<dyn Stream<Item = Result<Bytes, ApiErr>> + Send>, ApiErr>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<P, O> Future for Request<P, O, ()>

where P: Payload, O: DeserializeOwned,

type Output = Result<O, ApiErr>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'pin, P, O, M> Unpin for Request<P, O, M>

where P: Payload, PinnedFieldsOf<__Request<'pin, P, O, M>>: Unpin,