io-http 0.3.0

HTTP client library for Rust
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

//! Shared output and yield types for HTTP request-response coroutines.
//!
//! Both [`Http10Send`] and [`Http11Send`] return [`HttpSendOutput`] on
//! success and emit [`HttpSendYield`] on every intermediate step.
//!
//! [`Http10Send`]: crate::rfc1945::send::Http10Send
//! [`Http11Send`]: crate::rfc9112::send::Http11Send

use alloc::vec::Vec;

use url::Url;

use crate::{coroutine::HttpYield, rfc9110::response::HttpResponse};

/// Terminal output of a successful HTTP request-response exchange.
#[derive(Clone, Debug)]
pub struct HttpSendOutput {
    /// The parsed response, body included.
    pub response: HttpResponse,
    /// Bytes already buffered past the end of the response.
    pub remaining: Vec<u8>,
    /// Whether the server signalled the connection can be reused.
    pub keep_alive: bool,
}

/// Per-step yield emitted by `Http10Send` / `Http11Send`; adds
/// [`Self::WantsRedirect`] to the standard [`HttpYield`] for 3xx responses.
#[derive(Debug)]
pub enum HttpSendYield {
    /// The coroutine wants bytes read from the stream and handed back
    /// on the next resume.
    WantsRead,
    /// The coroutine wants these bytes written to the stream.
    WantsWrite(Vec<u8>),
    /// The server answered with a 3xx and a parseable location; the
    /// caller decides whether to follow.
    WantsRedirect {
        /// The redirect target, resolved against the request URL.
        url: Url,
        /// The 3xx response itself.
        response: HttpResponse,
        /// Whether the server signalled the connection can be reused.
        keep_alive: bool,
        /// `false` when the redirect crosses scheme/host/port; do not
        /// forward credentials without user consent (RFC 9110 ยง15.4).
        same_origin: bool,
    },
}

impl From<HttpYield> for HttpSendYield {
    fn from(y: HttpYield) -> Self {
        match y {
            HttpYield::WantsRead => Self::WantsRead,
            HttpYield::WantsWrite(bytes) => Self::WantsWrite(bytes),
        }
    }
}