Guidelines about HttpResponse.BodyWriter

[verdie-g]

There are currently two ways to write to the response body: HttpResponse.Body and HttpResponse.BodyWriter (ASP.NET 3+).

It would be great to document:

• when one should be used over the other
• can writes be interleaved between the two (one write to Body then one write to BodyWriter)
• should PipeWriter.FlushAsync be called manually
• how to write middleware supporting both (e.g. compression middleware)

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 49b15fd3-39b5-3ad9-8c4e-b8160360dee9
• Version Independent ID: c33981af-93ce-d4be-a265-5d4696666c7a
• Platform ID: 0e4358e6-746d-528b-cbca-ead48fe72c24
• Content: Request and Response operations in ASP.NET Core
• Content Source: aspnetcore/fundamentals/middleware/request-response.md
• Service: aspnet-core
• Sub-service: fundamentals
• GitHub Login: @tdykstra
• Microsoft Alias: tdykstra

---

Associated WorkItem - 423877

[martincostello]

This issue is probably more a candidate for dotnet/AspNetCore.Docs.

/cc @Rick-Anderson

[Rick-Anderson]

Per Request and response operations in ASP.NET Core

For request reading, HttpRequest.Body is a Stream, and HttpRequest.BodyReader is a PipeReader. For response writing, HttpResponse.Body is a Stream, and HttpResponse.BodyWriter is a PipeWriter.

Pipelines are recommended over streams. Streams can be easier to use for some simple

can writes be interleaved between the two (one write to Body then one write to BodyWriter)

NO

[verdie-g]

Thanks for the PR @Rick-Anderson. Could you also answer this

how to write middleware supporting both (e.g. compression middleware)

With Stream, it's easy, you wrap it in a compression stream. With the pipe writer, I'm not even sure how to detect the current response uses it and not the stream.