ringline-http 0.3.0

Async HTTP/1.1 and HTTP/2 client for the ringline io_uring runtime
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
90
91
92
93
94
95
96
97
98
99
100

//! Request builder for ergonomic HTTP request construction.

use crate::body::Body;
use crate::client::HttpClient;
use crate::error::HttpError;
use crate::response::Response;
use crate::streaming::StreamingResponse;

/// Builder for an HTTP request.
pub struct RequestBuilder<'a> {
    client: &'a mut HttpClient,
    method: String,
    path: String,
    headers: Vec<(String, String)>,
    body: Body,
}

impl<'a> RequestBuilder<'a> {
    pub(crate) fn new(client: &'a mut HttpClient, method: &str, path: &str) -> Self {
        Self {
            client,
            method: method.to_string(),
            path: path.to_string(),
            headers: Vec::new(),
            body: Body::Empty,
        }
    }

    /// Add a header to the request.
    pub fn header(mut self, name: &str, value: &str) -> Self {
        self.headers.push((name.to_string(), value.to_string()));
        self
    }

    /// Set the request body.
    pub fn body(mut self, body: impl Into<Body>) -> Self {
        self.body = body.into();
        self
    }

    /// Send the request and return the response.
    pub async fn send(mut self) -> Result<Response, HttpError> {
        self.inject_accept_encoding();

        let extra: Vec<(&str, &str)> = self
            .headers
            .iter()
            .map(|(k, v)| (k.as_str(), v.as_str()))
            .collect();

        let body_bytes = match &self.body {
            Body::Empty => None,
            Body::Bytes(b) => Some(b.as_ref()),
        };

        self.client
            .send_request(&self.method, &self.path, &extra, body_bytes)
            .await
    }

    /// Send the request and return a streaming response.
    ///
    /// Returns as soon as headers are received. Body chunks are yielded
    /// incrementally via [`StreamingResponse::next_chunk()`].
    ///
    /// **Note:** streaming responses do not automatically decompress the body.
    /// If the server sends a compressed response, chunks will contain raw
    /// compressed bytes. Buffer and decompress manually if needed.
    pub async fn send_streaming(mut self) -> Result<StreamingResponse<'a>, HttpError> {
        self.inject_accept_encoding();

        let extra: Vec<(&str, &str)> = self
            .headers
            .iter()
            .map(|(k, v)| (k.as_str(), v.as_str()))
            .collect();

        let body_bytes = match &self.body {
            Body::Empty => None,
            Body::Bytes(b) => Some(b.as_ref()),
        };

        self.client
            .send_request_streaming(&self.method, &self.path, &extra, body_bytes)
            .await
    }

    /// Inject `Accept-Encoding` header if compression features are enabled
    /// and the caller has not already set one.
    fn inject_accept_encoding(&mut self) {
        let has_ae = self
            .headers
            .iter()
            .any(|(name, _)| name.eq_ignore_ascii_case("accept-encoding"));
        if !has_ae && let Some(ae) = crate::compress::accept_encoding_value() {
            self.headers
                .push(("accept-encoding".to_string(), ae.to_string()));
        }
    }
}