Add RawResponse to ErrorKind::HttpResponse (#2983)

Renames `RawResponse` to `BufResponse` - inspired by
`std::io::BufReader`, and adds a new `RawResponse` where the body is
fully read and stored in `Bytes`.
Refactored `Headers` and other types necessary to add `RawResponse` to
`ErrorKind::HttpResponse`.

Fixes #2962
Fixes #2495
Relates to #2725
Relates to #1995

Author: heaths

Cargo.lock

@@ -4,21 +4,23 @@
 
 ### Features Added
 
+- Added `RawResponse` to `ErrorKind::HttpResponse` that contains the HTTP status code, headers, and complete error response body.
 - Added `RequestContent::from_slice()`.
 - Added `TryFrom<T> for RequestContent<T, JsonFormat>` for JSON primitives.
 - Added support for WASM to the `async_runtime` module.
 - Added logging policy to log HTTP requests and responses in the pipeline. As a part of this change, sanitization support was added to places which log HTTP headers and URLs. The `azure_core::http::ClientOptions` has been enhanced with a `LoggingOptions` which allows a user/service client to specify headers or URL query parameters which should be allowed. Note that the sanitization feature is disabled if you build with the `debug` feature enabled.
 
 ### Breaking Changes
 
+- Added the ability to configure pipeline configuration independently from `ClientOptions`. This adds a new optional `PipelineOptions` parameter to `azure_core::http::Pipeline::new()`. If not specified, it defaults to the expected options for `azure_core` services.
 - Changed `FromStr for RequestContent<T, F>` to `RequestContent::from_str()`.
 - Changed `TryFrom<&'static str> for RequestContent<T, F>` to `RequestContent::from_static()`.
 - Changed `TryFrom<Bytes> for RequestContent<T, F>` to `From<Bytes> for RequestContent<T, F>` because it was already infallible.
 - Removed `TryFrom<Vec<u8>> for RequestContent<T, F>` since `RequestContent::from()` already exists.
 - Removed feature `reqwest_rustls_tls`. See [README.md](https://github.com/heaths/azure-sdk-for-rust/blob/main/sdk/core/azure_core/README.md) for alternative HTTP client configuration.
 - Removed the `fs` module including the `FileStream` and `FileStreamBuilder` types. Moved to `examples/` for `typespec_client_core` to copy if needed.
 - Removed the `setters` macro.
-- Added the ability to configure pipeline configuration independently from `ClientOptions`. This adds a new optional `PipelineOptions` parameter to `azure_core::http::Pipeline::new()`. If not specified, it defaults to the expected options for `azure_core` services.
+- Renamed `RawResponse` to `BufResponse`. New `RawResponse` contains complete body as `Bytes` used in `ErrorKind::HttpResponse`.
 
 ## 0.27.0 (2025-08-01)
 

sdk/core/azure_core/CHANGELOG.md

@@ -483,7 +483,7 @@ ureq = { version = "3", default-features = false, features = [
 Then we need to implement `HttpClient` for another HTTP client like [`ureq`](https://docs.rs/ureq):
 
 ```rust no_run
-use azure_core::{error::{ErrorKind, ResultExt as _}, http::{HttpClient, RawResponse, Request}};
+use azure_core::{error::{ErrorKind, ResultExt as _}, http::{HttpClient, BufResponse, Request}};
 use ureq::tls::{TlsConfig, TlsProvider};
 
 #[derive(Debug)]
@@ -507,7 +507,7 @@ impl Default for Agent {
 
 #[async_trait::async_trait]
 impl HttpClient for Agent {
-    async fn execute_request(&self, request: &Request) -> azure_core::Result<RawResponse> {
+    async fn execute_request(&self, request: &Request) -> azure_core::Result<BufResponse> {
         let request: ::http::request::Request<Vec<u8>> = todo!("convert our request into their request");
         let response = self
             .0

sdk/core/azure_core/README.md

@@ -1,5 +1,5 @@
 use azure_core::http::{
-    headers::Headers, HttpClient, Method, RawResponse, Request, StatusCode, Url,
+    headers::Headers, BufResponse, HttpClient, Method, Request, StatusCode, Url,
 };
 use azure_core_test::http::MockHttpClient;
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
@@ -31,7 +31,7 @@ fn http_transport_test(c: &mut Criterion) {
     // client to be used in the benchmark
     let mock_client = Arc::new(MockHttpClient::new(move |_| {
         async move {
-            Ok(RawResponse::from_bytes(
+            Ok(BufResponse::from_bytes(
                 StatusCode::Ok,
                 Headers::new(),
                 vec![],

sdk/core/azure_core/benches/benchmarks.rs

@@ -5,7 +5,7 @@ use azure_core::{
     credentials::TokenCredential,
     fmt::SafeDebug,
     http::{
-        ClientMethodOptions, ClientOptions, HttpClient, Method, Pipeline, RawResponse, Request,
+        BufResponse, ClientMethodOptions, ClientOptions, HttpClient, Method, Pipeline, Request,
         TransportOptions, Url,
     },
     Result,
@@ -85,7 +85,7 @@ impl TestServiceClient {
         &self,
         path: &str,
         options: Option<TestServiceClientGetMethodOptions<'_>>,
-    ) -> Result<RawResponse> {
+    ) -> Result<BufResponse> {
         let options = options.unwrap_or_default();
         let mut url = self.endpoint.clone();
         url.set_path(path);
@@ -103,6 +103,7 @@ impl TestServiceClient {
                 azure_core::error::ErrorKind::HttpResponse {
                     status: response.status(),
                     error_code: None,
+                    raw_response: None,
                 },
                 format!("Failed to GET {}: {}", request.url(), response.status()),
             ));

sdk/core/azure_core/benches/http_transport_benchmarks.rs

@@ -3,7 +3,7 @@
 
 use azure_core::{
     credentials::TokenCredential,
-    http::{headers::Headers, HttpClient, Method, RawResponse, StatusCode, TransportOptions},
+    http::{headers::Headers, BufResponse, HttpClient, Method, StatusCode, TransportOptions},
 };
 use azure_core_test::{credentials::MockCredential, http::MockHttpClient};
 use azure_security_keyvault_secrets::{ResourceExt, SecretClient, SecretClientOptions};
@@ -64,7 +64,7 @@ fn setup() -> Result<(Arc<dyn TokenCredential>, Arc<dyn HttpClient>), Box<dyn st
                 assert_eq!(request.method(), Method::Get);
                 assert_eq!(request.url().path(), "/secrets");
                 match idx {
-                    0 => Ok(RawResponse::from_bytes(
+                    0 => Ok(BufResponse::from_bytes(
                         StatusCode::Ok,
                         Headers::new(),
                         // First page with continuation (nextLink)
@@ -74,7 +74,7 @@ fn setup() -> Result<(Arc<dyn TokenCredential>, Arc<dyn HttpClient>), Box<dyn st
                           ],
                           "nextLink":"https://my-vault.vault.azure.net/secrets?api-version=7.4&$skiptoken=page2"}"#,
                     )),
-                    1 => Ok(RawResponse::from_bytes(
+                    1 => Ok(BufResponse::from_bytes(
                         StatusCode::Ok,
                         Headers::new(),
                         // Second (final) page without nextLink

sdk/core/azure_core/examples/core_pager.rs

@@ -5,7 +5,7 @@ use azure_core::{
     credentials::TokenCredential,
     http::{
         headers::{Headers, RETRY_AFTER},
-        HttpClient, Method, RawResponse, StatusCode, TransportOptions,
+        BufResponse, HttpClient, Method, StatusCode, TransportOptions,
     },
 };
 use azure_core_test::{credentials::MockCredential, http::MockHttpClient};
@@ -78,7 +78,7 @@ fn setup() -> Result<(Arc<dyn TokenCredential>, Arc<dyn HttpClient>), Box<dyn st
                         assert!(request.url().path().starts_with("/certificates/my-cert/create"));
                         let mut headers = Headers::new();
                         headers.insert(RETRY_AFTER, "0");
-                        Ok(RawResponse::from_bytes(
+                        Ok(BufResponse::from_bytes(
                             StatusCode::Ok,
                             headers,
                             r#"{"id":"https://my-vault.vault.azure.net/certificates/my-cert/pending","status":"inProgress"}"#,
@@ -88,7 +88,7 @@ fn setup() -> Result<(Arc<dyn TokenCredential>, Arc<dyn HttpClient>), Box<dyn st
                         // Polling GET for status
                         assert_eq!(request.method(), Method::Get);
                         assert!(request.url().path().starts_with("/certificates/my-cert/pending"));
-                        Ok(RawResponse::from_bytes(
+                        Ok(BufResponse::from_bytes(
                             StatusCode::Ok,
                             Headers::new(),
                             r#"{"id":"https://my-vault.vault.azure.net/certificates/my-cert/pending","status":"completed","target":"https://my-vault.vault.azure.net/certificates/my-cert"}"#,

sdk/core/azure_core/examples/core_poller.rs

@@ -7,7 +7,7 @@ use azure_core::{
     http::{
         headers::Headers,
         policies::{Policy, PolicyResult},
-        Context, HttpClient, Method, RawResponse, Request, StatusCode, TransportOptions,
+        BufResponse, Context, HttpClient, Method, Request, StatusCode, TransportOptions,
     },
 };
 use azure_core_test::{credentials::MockCredential, http::MockHttpClient};
@@ -96,7 +96,7 @@ fn setup() -> Result<(Arc<dyn TokenCredential>, Arc<dyn HttpClient>), Box<dyn st
                     .any(|(name, _)| name.as_str().eq_ignore_ascii_case("user-agent")),
                 "user-agent header should be absent"
             );
-            Ok(RawResponse::from_bytes(
+            Ok(BufResponse::from_bytes(
                 StatusCode::Ok,
                 Headers::new(),
                 r#"{"value":"secret-value"}"#,

sdk/core/azure_core/examples/core_remove_user_agent.rs

@@ -4,7 +4,7 @@
 use async_trait::async_trait;
 use azure_core::{
     error::ErrorKind,
-    http::{headers::Headers, ClientOptions, HttpClient, RawResponse, Request, TransportOptions},
+    http::{headers::Headers, BufResponse, ClientOptions, HttpClient, Request, TransportOptions},
 };
 use azure_identity::DeveloperToolsCredential;
 use azure_security_keyvault_secrets::{ResourceExt as _, SecretClient, SecretClientOptions};
@@ -35,7 +35,7 @@ impl Default for Agent {
 #[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
 #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
 impl HttpClient for Agent {
-    async fn execute_request(&self, request: &Request) -> azure_core::Result<RawResponse> {
+    async fn execute_request(&self, request: &Request) -> azure_core::Result<BufResponse> {
         let request = into_request(request)?;
         let response = self
             .0
@@ -102,7 +102,7 @@ fn into_request(request: &Request) -> azure_core::Result<::http::Request<Vec<u8>
     Ok(req)
 }
 
-fn into_response(response: ::http::Response<ureq::Body>) -> azure_core::Result<RawResponse> {
+fn into_response(response: ::http::Response<ureq::Body>) -> azure_core::Result<BufResponse> {
     use ::http::response::Parts;
     use azure_core::http::StatusCode;
 
@@ -128,5 +128,5 @@ fn into_response(response: ::http::Response<ureq::Body>) -> azure_core::Result<R
         .read_to_vec()
         .with_context(ErrorKind::Io, || "failed to read response body")?;
 
-    Ok(RawResponse::from_bytes(status, response_headers, body))
+    Ok(BufResponse::from_bytes(status, response_headers, body))
 }

sdk/core/azure_core/examples/core_ureq_client.rs

@@ -18,7 +18,7 @@ pub use pager::{ItemIterator, PageIterator, Pager};
 pub use pipeline::*;
 pub use poller::Poller;
 pub use request::{Body, Request, RequestContent};
-pub use response::{RawResponse, Response};
+pub use response::{BufResponse, Response};
 
 pub use typespec_client_core::http::response;
 pub use typespec_client_core::http::{