Struct ApiRequest 

pub struct ApiRequest<T> {
    pub method: Method,
    pub path: String,
    pub query: Option<String>,
    pub body: Option<String>,
    pub _marker: PhantomData<T>,
}

A type-safe API request built by the api! macro.

T is the expected response type, inferred from the OpenAPI spec at compile time.

Fields

method: Method

path: String

query: Option<String>

body: Option<String>

_marker: PhantomData<T>

Implementations

impl<T> ApiRequest<T>

pub fn new(method: Method, path: String) -> Self

pub fn query_raw(self, qs: impl Into<String>) -> Self

pub fn body_json(self, body: &impl Serialize) -> Self

pub fn try_body_json(self, body: &impl Serialize) -> Result<Self, ApiError>

Set a pre-serialized JSON body. Returns an error if serialization fails.

impl<T: DeserializeOwned> ApiRequest<T>

pub async fn fetch( self, client: &(impl ApiClient + ?Sized), ) -> Result<T, ApiError>

Execute the request and deserialize the response.

impl ApiRequest<()>

pub async fn fetch_empty( self, client: &(impl ApiClient + ?Sized), ) -> Result<(), ApiError>

Execute a request that returns no body (e.g. DELETE, PUT with 204).

impl<T> ApiRequest<T>

pub async fn fetch_stream( self, client: &(impl ApiClient + ?Sized), ) -> Result<impl Stream<Item = Result<SseEvent, ApiError>>, ApiError>

Execute the request and return an SSE event stream.