hey-sdk 0.31.0

Rust client for the HEY API, generated from a Smithy model of the API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use std::time::Duration;

use async_trait::async_trait;
use bytes::Bytes;
use futures_util::stream;
use reqwest::redirect::Policy;

use crate::client::DEFAULT_TIMEOUT;
use crate::error::Error;
use crate::http::{Body, HttpClient, Request, Response};

/// The [`HttpClient`] the SDK ships, over [`reqwest`] with rustls and HTTP/2. This is what a
/// client gets when nothing else is supplied.
///
/// It never follows a redirect, whatever it was built from: the SDK does that itself.
#[derive(Debug, Clone)]
pub struct ReqwestClient {
    http: reqwest::Client,
}

impl ReqwestClient {
    /// A client that gives an answer `timeout` to arrive.
    pub fn with_timeout(timeout: Duration) -> Result<ReqwestClient, Error> {
        ReqwestClient::from_builder(reqwest::Client::builder().timeout(timeout))
    }

    /// A client built from settings of the caller's own — a proxy, a root certificate, a set
    /// of default headers. Whatever redirect policy the builder carries is replaced with
    /// none, since following one here would hide it from the SDK.
    pub fn from_builder(builder: reqwest::ClientBuilder) -> Result<ReqwestClient, Error> {
        let http = builder
            .redirect(Policy::none())
            .build()
            .map_err(|error| Error::usage(format!("HTTP client: {error}")))?;
        Ok(ReqwestClient { http })
    }
}

/// The shipped client at its default timeout.
///
/// # Panics
///
/// When reqwest cannot build a client at all — a TLS backend that fails to initialize is the
/// one way. `Default` has no way to say so; a caller that would rather have the error uses
/// [`ReqwestClient::with_timeout`] or [`ReqwestClient::from_builder`].
impl Default for ReqwestClient {
    #[allow(clippy::expect_used)] // `Default` cannot return the error; the fallible constructors can, see above
    fn default() -> ReqwestClient {
        ReqwestClient::with_timeout(DEFAULT_TIMEOUT)
            .expect("reqwest builds a client from its defaults")
    }
}

#[async_trait]
impl HttpClient for ReqwestClient {
    async fn send(&self, request: Request<Bytes>) -> Result<Response<Body>, Error> {
        let request = reqwest::Request::try_from(request).map_err(network)?;
        let answered = self.http.execute(request).await.map_err(network)?;

        let status = answered.status();
        let version = answered.version();
        let headers = answered.headers().clone();
        let content_length = answered.content_length();

        let mut response = Response::new(Body::from_stream(chunks(answered), content_length));
        *response.status_mut() = status;
        *response.version_mut() = version;
        *response.headers_mut() = headers;
        Ok(response)
    }
}

/// The body a chunk at a time: reqwest hands it out with `chunk()`, so the stream is that
/// call repeated until it answers `None`.
fn chunks(response: reqwest::Response) -> impl stream::Stream<Item = Result<Bytes, Error>> + Send {
    stream::try_unfold(response, |mut response| async move {
        match response.chunk().await {
            Ok(Some(chunk)) => Ok(Some((chunk, response))),
            Ok(None) => Ok(None),
            Err(error) => Err(network(error)),
        }
    })
}

/// A transport failure as the SDK's network error, less the URL reqwest writes into its
/// own message: the failure ends up in logs and hints, and the URL carries the query.
fn network(error: reqwest::Error) -> Error {
    Error::network(error.without_url())
}