hotaru_http 0.8.2

HTTP/1.1 implementation for the Hotaru web framework
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

//! HTTP-level channel trait — the I/O surface every HTTP version must provide.
//!
//! `HttpChannel` extends the framework-level [`Channel`] trait with HTTP-specific
//! I/O methods (parse request/response, send request/response). Every HTTP
//! version (HTTP/1.1, HTTP/2, HTTP/3) implements this trait so that the
//! protocol-level `handle` / `send` logic can be written generically.

use std::net::SocketAddr;

use async_trait::async_trait;
use hotaru_core::protocol::Channel;

use crate::message::request::HttpRequest;
use crate::message::response::HttpResponse;
use crate::protocol::error::HttpError;
use crate::security::safety::HttpSafety;

/// HTTP-level channel — the I/O surface every HTTP version must provide.
///
/// This trait sits between the framework [`Channel`] trait (which only knows
/// about open/close) and the concrete HTTP version implementations. It defines:
///
/// - The four fundamental HTTP I/O operations (parse/send request and response).
/// - The connection's local/remote addresses, when available.
///
/// Addresses are returned as `Option<SocketAddr>` because non-TCP backings
/// (in-process channels, Unix sockets, QUIC during address migration) may
/// not have a meaningful `SocketAddr`.
///
/// The trait is decorated with `#[async_trait]` for consistency with
/// [`hotaru_core::protocol::Protocol`] and so that generic code over
/// `H: HttpChannel` can use the returned futures in `Send`-required async
/// contexts (e.g. `tokio::spawn`) without extra associated-type-bound syntax.
#[async_trait]
pub trait HttpChannel: Channel {
    /// Parse one HTTP request from the channel's reader.
    ///
    /// On EOF / malformed input, implementations should flip the channel
    /// closed and return an [`HttpError::Io`] with `UnexpectedEof`.
    async fn parse_request(&self, safety: &HttpSafety) -> Result<HttpRequest, HttpError>;

    /// Send an HTTP response on the channel's writer.
    async fn send_response(&self, response: HttpResponse) -> Result<(), HttpError>;

    /// Send an HTTP request on the channel's writer (client-side).
    async fn send_request(&self, request: HttpRequest) -> Result<(), HttpError>;

    /// Parse one HTTP response from the channel's reader (client-side).
    async fn parse_response(&self, safety: &HttpSafety) -> Result<HttpResponse, HttpError>;

    /// Local socket address of the underlying connection, if any.
    fn local_addr(&self) -> Option<SocketAddr>;

    /// Remote socket address of the underlying connection, if any.
    fn remote_addr(&self) -> Option<SocketAddr>;
}