nyquest_interface/async/
any.rs

1//! Type-erased async client interface traits.
2//!
3//! This module provides trait definitions for type-erased asynchronous HTTP client
4//! implementations, allowing different backend implementations to be used interchangeably.
5//!
6//! The traits in this module are automatically implemented for types that implement the
7//! corresponding traits from the `async::backend` module, so backend developers don't need
8//! to implement them directly.
9
10use std::any::Any;
11use std::fmt;
12use std::pin::Pin;
13use std::sync::Arc;
14
15use futures_core::future::BoxFuture;
16
17use super::backend::AsyncResponse;
18use super::Request;
19use crate::client::ClientOptions;
20use crate::Result;
21
22/// Trait for type-erased async backend implementations.
23///
24/// Automatically implemented for types implementing `AsyncBackend`.
25pub trait AnyAsyncBackend: Send + Sync + 'static {
26    /// Creates a new async client with the given options.
27    fn create_async_client(
28        &self,
29        options: ClientOptions,
30    ) -> BoxFuture<'_, Result<Arc<dyn AnyAsyncClient>>>;
31}
32
33/// Trait for type-erased async HTTP clients.
34///
35/// Automatically implemented for types implementing `AsyncClient`.
36pub trait AnyAsyncClient: Any + Send + Sync + 'static {
37    /// Provides a textual description of this client.
38    fn describe(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result;
39    /// Sends an HTTP request and returns the response.
40    fn request(&self, req: Request) -> BoxFuture<'_, Result<Pin<Box<dyn AnyAsyncResponse>>>>;
41}
42
43/// Trait for type-erased async HTTP responses.
44///
45/// Automatically implemented for types implementing `AsyncResponse`.
46pub trait AnyAsyncResponse: super::MaybeAsyncRead + Any + Send + Sync + 'static {
47    /// Provides a textual description of this response.
48    fn describe(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result;
49    /// Returns the HTTP status code of this response.
50    fn status(&self) -> u16;
51    /// Returns the content-length of the response body, if known.
52    fn content_length(&self) -> Option<u64>;
53    /// Gets all values for the specified header.
54    fn get_header(&self, header: &str) -> Result<Vec<String>>;
55    /// Reads the response body as text.
56    fn text(self: Pin<&mut Self>) -> BoxFuture<'_, Result<String>>;
57    /// Reads the response body as bytes.
58    fn bytes(self: Pin<&mut Self>) -> BoxFuture<'_, Result<Vec<u8>>>;
59}
60
61// These implementations allow backend types implementing the base traits
62// to be used with the type-erased trait system automatically.
63
64impl<R> AnyAsyncResponse for R
65where
66    R: AsyncResponse,
67{
68    fn status(&self) -> u16 {
69        AsyncResponse::status(self)
70    }
71
72    fn content_length(&self) -> Option<u64> {
73        AsyncResponse::content_length(self)
74    }
75
76    fn get_header(&self, header: &str) -> Result<Vec<String>> {
77        AsyncResponse::get_header(self, header)
78    }
79
80    fn text(self: Pin<&mut Self>) -> BoxFuture<'_, Result<String>> {
81        Box::pin(AsyncResponse::text(self))
82    }
83
84    fn bytes(self: Pin<&mut Self>) -> BoxFuture<'_, Result<Vec<u8>>> {
85        Box::pin(AsyncResponse::bytes(self))
86    }
87
88    fn describe(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
89        AsyncResponse::describe(self, f)
90    }
91}
92
93impl<A> AnyAsyncBackend for A
94where
95    A: super::backend::AsyncBackend,
96    A::AsyncClient: super::backend::AsyncClient,
97{
98    fn create_async_client(
99        &self,
100        options: ClientOptions,
101    ) -> BoxFuture<'_, Result<Arc<dyn AnyAsyncClient>>> {
102        Box::pin(async {
103            super::backend::AsyncBackend::create_async_client(self, options)
104                .await
105                .map(|client| Arc::new(client) as Arc<dyn AnyAsyncClient>)
106        }) as _
107    }
108}
109
110impl<A> AnyAsyncClient for A
111where
112    A: super::backend::AsyncClient,
113{
114    fn describe(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
115        super::backend::AsyncClient::describe(self, f)
116    }
117
118    fn request(&self, req: Request) -> BoxFuture<'_, Result<Pin<Box<dyn AnyAsyncResponse>>>> {
119        Box::pin(async {
120            self.request(req)
121                .await
122                .map(|res| Box::pin(res) as Pin<Box<dyn AnyAsyncResponse>>)
123        }) as _
124    }
125}
nyquest_interface/async/any.rs

nyquest_interface/async/
any.rs
