mod builder;
mod connect;
mod dispatch;
mod execute;
mod resolve;
pub use builder::ClientBuilder;
use std::marker::PhantomData;
use std::net::IpAddr;
#[cfg(unix)]
use std::path::PathBuf;
use std::sync::Arc;
use std::time::Duration;
use bytes::Bytes;
use http::header::HeaderMap;
use http::{Method, StatusCode, Uri};
use http_body_util::BodyExt;
use crate::cache::HttpCache;
use crate::cookie::CookieJar;
use crate::error::{AioductBody, Error};
use crate::h2c_probe::H2cProbeCache;
use crate::http2::Http2Config;
use crate::middleware::MiddlewareStack;
use crate::pool::ConnectionPool;
use crate::proxy::ProxySettings;
use crate::redirect::RedirectPolicy;
use crate::request::RequestBuilder;
use crate::retry::RetryConfig;
use crate::runtime::{Resolve, Runtime};
const DEFAULT_USER_AGENT: &str = concat!("aioduct/", env!("CARGO_PKG_VERSION"));
pub struct Client<R: Runtime> {
pub(crate) pool: ConnectionPool<R>,
pub(crate) redirect_policy: RedirectPolicy,
pub(crate) timeout: Option<Duration>,
pub(crate) connect_timeout: Option<Duration>,
pub(crate) read_timeout: Option<Duration>,
pub(crate) tcp_keepalive: Option<Duration>,
pub(crate) tcp_keepalive_interval: Option<Duration>,
pub(crate) tcp_keepalive_retries: Option<u32>,
pub(crate) local_address: Option<IpAddr>,
#[cfg(target_os = "linux")]
pub(crate) interface: Option<String>,
#[cfg(unix)]
pub(crate) unix_socket: Option<PathBuf>,
pub(crate) https_only: bool,
pub(crate) referer: bool,
pub(crate) no_connection_reuse: bool,
pub(crate) tcp_fast_open: bool,
pub(crate) http2_prior_knowledge: bool,
pub(crate) accept_encoding: crate::decompress::AcceptEncoding,
pub(crate) default_headers: HeaderMap,
pub(crate) retry: Option<RetryConfig>,
pub(crate) cookie_jar: Option<CookieJar>,
pub(crate) proxy: Option<ProxySettings>,
pub(crate) resolver: Option<Arc<dyn Resolve>>,
pub(crate) http2: Option<Http2Config>,
pub(crate) middleware: MiddlewareStack,
pub(crate) rate_limiter: Option<crate::throttle::RateLimiter>,
pub(crate) bandwidth_limiter: Option<crate::bandwidth::BandwidthLimiter>,
pub(crate) digest_auth: Option<crate::digest_auth::DigestAuth>,
pub(crate) cache: Option<HttpCache>,
pub(crate) hsts: Option<crate::hsts::HstsStore>,
pub(crate) h2c_probe_cache: H2cProbeCache,
pub(crate) connection_coalescing: bool,
#[cfg(feature = "tower")]
pub(crate) connector: Option<crate::connector::LayeredConnector<R>>,
#[cfg(feature = "rustls")]
pub(crate) tls: Option<Arc<crate::tls::RustlsConnector>>,
#[cfg(all(feature = "http3", feature = "rustls"))]
pub(crate) h3_endpoint: Option<quinn::Endpoint>,
#[cfg(all(feature = "http3", feature = "rustls"))]
pub(crate) prefer_h3: bool,
#[cfg(all(feature = "http3", feature = "rustls"))]
pub(crate) h3_zero_rtt: bool,
#[cfg(all(feature = "http3", feature = "rustls"))]
pub(crate) alt_svc_cache: crate::alt_svc::AltSvcCache,
pub(crate) _runtime: PhantomData<R>,
}
impl<R: Runtime> Clone for Client<R> {
fn clone(&self) -> Self {
Self {
pool: self.pool.clone(),
redirect_policy: self.redirect_policy.clone(),
timeout: self.timeout,
connect_timeout: self.connect_timeout,
read_timeout: self.read_timeout,
tcp_keepalive: self.tcp_keepalive,
tcp_keepalive_interval: self.tcp_keepalive_interval,
tcp_keepalive_retries: self.tcp_keepalive_retries,
local_address: self.local_address,
#[cfg(target_os = "linux")]
interface: self.interface.clone(),
#[cfg(unix)]
unix_socket: self.unix_socket.clone(),
https_only: self.https_only,
referer: self.referer,
no_connection_reuse: self.no_connection_reuse,
tcp_fast_open: self.tcp_fast_open,
http2_prior_knowledge: self.http2_prior_knowledge,
accept_encoding: self.accept_encoding.clone(),
default_headers: self.default_headers.clone(),
retry: self.retry.clone(),
cookie_jar: self.cookie_jar.clone(),
proxy: self.proxy.clone(),
resolver: self.resolver.clone(),
http2: self.http2.clone(),
middleware: self.middleware.clone(),
rate_limiter: self.rate_limiter.clone(),
bandwidth_limiter: self.bandwidth_limiter.clone(),
digest_auth: self.digest_auth.clone(),
cache: self.cache.clone(),
hsts: self.hsts.clone(),
h2c_probe_cache: self.h2c_probe_cache.clone(),
connection_coalescing: self.connection_coalescing,
#[cfg(feature = "tower")]
connector: self.connector.clone(),
#[cfg(feature = "rustls")]
tls: self.tls.clone(),
#[cfg(all(feature = "http3", feature = "rustls"))]
h3_endpoint: self.h3_endpoint.clone(),
#[cfg(all(feature = "http3", feature = "rustls"))]
prefer_h3: self.prefer_h3,
#[cfg(all(feature = "http3", feature = "rustls"))]
h3_zero_rtt: self.h3_zero_rtt,
#[cfg(all(feature = "http3", feature = "rustls"))]
alt_svc_cache: self.alt_svc_cache.clone(),
_runtime: PhantomData,
}
}
}
impl<R: Runtime> std::fmt::Debug for Client<R> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Client").finish()
}
}
impl<R: Runtime> Default for Client<R> {
fn default() -> Self {
Self::new()
}
}
impl<R: Runtime> Client<R> {
pub fn builder() -> ClientBuilder<R> {
ClientBuilder::default()
}
pub fn new() -> Self {
Self::builder().build()
}
#[cfg(feature = "rustls")]
pub fn with_rustls() -> Self {
Self::builder()
.tls(crate::tls::RustlsConnector::with_webpki_roots())
.build()
}
#[cfg(feature = "rustls-native-roots")]
pub fn with_native_roots() -> Self {
Self::builder()
.tls(crate::tls::RustlsConnector::with_native_roots())
.build()
}
#[cfg(all(feature = "http3", feature = "rustls"))]
pub fn with_http3() -> Self {
Self::builder()
.tls(crate::tls::RustlsConnector::with_webpki_roots())
.http3(true)
.build()
}
#[cfg(all(feature = "http3", feature = "rustls"))]
pub fn with_alt_svc_h3() -> Self {
Self::builder()
.tls(crate::tls::RustlsConnector::with_webpki_roots())
.alt_svc_h3(true)
.build()
}
pub fn get(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::GET, uri))
}
pub fn head(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::HEAD, uri))
}
pub fn post(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::POST, uri))
}
pub fn put(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::PUT, uri))
}
pub fn patch(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::PATCH, uri))
}
pub fn delete(&self, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, Method::DELETE, uri))
}
pub fn request(&self, method: Method, uri: &str) -> Result<RequestBuilder<'_, R>, Error> {
let uri: Uri = uri.parse().map_err(|e| Error::InvalidUrl(format!("{e}")))?;
Ok(RequestBuilder::new(self, method, uri))
}
pub fn chunk_download(&self, url: &str) -> crate::chunk_download::ChunkDownload<R> {
crate::chunk_download::ChunkDownload::new(self.clone(), url.to_owned())
}
pub fn forward<B>(&self, request: http::Request<B>) -> crate::forward::ForwardBuilder<'_, R, B>
where
B: http_body::Body<Data = Bytes> + Send + 'static,
B::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
{
crate::forward::ForwardBuilder::new(self, request)
}
pub(crate) fn default_timeout(&self) -> Option<Duration> {
self.timeout
}
pub(crate) fn default_retry(&self) -> Option<&RetryConfig> {
self.retry.as_ref()
}
pub(crate) fn middleware(&self) -> &crate::middleware::MiddlewareStack {
&self.middleware
}
pub fn bandwidth_limiter(&self) -> Option<&crate::bandwidth::BandwidthLimiter> {
self.bandwidth_limiter.as_ref()
}
}
fn resolve_redirect(base: &Uri, location: &str) -> Result<Uri, Error> {
base.scheme_str()
.ok_or_else(|| Error::InvalidUrl("missing scheme in base".into()))?;
base.authority()
.ok_or_else(|| Error::InvalidUrl("missing authority in base".into()))?;
let base_url =
url::Url::parse(&base.to_string()).map_err(|e| Error::InvalidUrl(e.to_string()))?;
let mut next = base_url
.join(location)
.map_err(|e| Error::InvalidUrl(format!("invalid redirect URL: {e}")))?;
next.set_fragment(None);
next.as_str()
.parse()
.map_err(|e| Error::InvalidUrl(format!("invalid redirect URL: {e}")))
}
fn boxed_response_from_bytes(
status: StatusCode,
headers: &HeaderMap,
body: Bytes,
) -> http::Response<AioductBody> {
let mut builder = http::Response::builder().status(status);
for (name, value) in headers {
builder = builder.header(name, value);
}
builder
.body(
http_body_util::Full::new(body)
.map_err(|never| match never {})
.boxed_unsync(),
)
.expect("response builder with valid status cannot fail")
}
#[cfg(test)]
mod tests;