cf-gears-toolkit-http 0.8.0

ToolKit HTTP client library
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

#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#![warn(warnings)]

//! HTTP client infrastructure for `ToolKit`
//!
//! This crate provides a hyper-based HTTP client with:
//! - Automatic TLS via rustls; transport security is configurable via
//!   [`TransportSecurity`] — defaults to
//!   `TlsOnly` (HTTPS-only) under `--features fips`, `AllowInsecureHttp` otherwise
//! - Connection pooling
//! - Configurable timeouts
//! - Automatic retries with exponential backoff
//! - User-Agent header injection
//! - Concurrency limiting
//! - **Transparent response decompression** (gzip, brotli, deflate)
//! - Optional OpenTelemetry tracing (feature-gated)
//!
//! # Transparent Decompression
//!
//! The client automatically:
//! - Sends `Accept-Encoding: gzip, br, deflate` header on all requests
//! - Decompresses response bodies based on `Content-Encoding` header
//! - Applies body size limits to **decompressed** bytes (protecting against zip bombs)
//!
//! No configuration is required; decompression is always enabled.
//!
//! # Example
//!
//! ```ignore
//! use toolkit_http::{HttpClient, HttpClientBuilder};
//! use std::time::Duration;
//!
//! let client = HttpClient::builder()
//!     .timeout(Duration::from_secs(10))
//!     .user_agent("my-app/1.0")
//!     .build()?;
//!
//! // reqwest-like API: response has body-reading methods
//! // Compressed responses are automatically decompressed
//! let data: MyData = client
//!     .get("https://example.com/api")
//!     .send()
//!     .await?
//!     .json()
//!     .await?;
//! ```

/// Builder for configuring and constructing the HTTP client.
mod builder;
/// The HTTP client implementation.
mod client;
/// Client configuration types.
mod config;
/// Error types returned by the HTTP client.
mod error;
mod layers;
pub mod otel;
/// Request builder types.
mod request;
/// Response types with body-size-limited readers.
mod response;
pub mod security;
mod tls;

pub use builder::HttpClientBuilder;
pub use client::HttpClient;
/// TLS building blocks shared with other transport crates (e.g. the upstream
/// proxy engine) so every outbound `ClientConfig` goes through the same
/// provider selection and FIPS hardening.
pub use config::{ClientAuthConfig, TlsConfig, TlsVersion};
pub use config::{
    DEFAULT_USER_AGENT, ExponentialBackoff, HttpClientConfig, IDEMPOTENCY_KEY_HEADER,
    RateLimitConfig, RedirectConfig, RetryConfig, RetryTrigger, TlsRootConfig, TransportSecurity,
    is_idempotent_method,
};
pub use error::{HttpError, InvalidUriKind};
#[cfg(feature = "otel")]
pub use layers::{ClassifyFn, MetricsLayer, MetricsService, default_classify};
pub use layers::{
    OtelLayer, OtelService, RETRY_ATTEMPT_HEADER, RetryLayer, RetryService, SecureRedirectPolicy,
    UserAgentLayer, UserAgentService,
};
pub use request::{RequestBuilder, RequestType};
pub use response::{HttpResponse, LimitedBody, ResponseBody};
pub use security::{attach_bearer_http, attach_internal_token_http};
pub use tls::TlsConfigError;
pub use tls::{custom_roots_client_config, native_roots_client_config, webpki_roots_client_config};