Results.Stream Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Allows writing directly to the response body. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable). |
| Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Writes the contents of specified PipeReader to the response. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable). |
| Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Writes the specified Stream to the response. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable). This API is an alias for File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean). |
Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)
Allows writing directly to the response body.
This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
public static Microsoft.AspNetCore.Http.IResult Stream (Func<System.IO.Stream,System.Threading.Tasks.Task> streamWriterCallback, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default);static member Stream : Func<System.IO.Stream, System.Threading.Tasks.Task> * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Http.IResultPublic Shared Function Stream (streamWriterCallback As Func(Of Stream, Task), Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing) As IResultParameters
The callback that allows users to write directly to the response body.
- contentType
- String
The Content-Type of the response. Defaults to application/octet-stream.
- fileDownloadName
- String
The the file name to be used in the Content-Disposition header.
- lastModified
- Nullable<DateTimeOffset>
The DateTimeOffset of when the file was last modified.
Used to configure the Last-Modified response header and perform conditional range requests.
- entityTag
- EntityTagHeaderValue
The EntityTagHeaderValue to be configure the ETag response header
and perform conditional requests.
Returns
The created IResult for the response.
Applies to
Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)
Writes the contents of specified PipeReader to the response.
This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
public static Microsoft.AspNetCore.Http.IResult Stream (System.IO.Pipelines.PipeReader pipeReader, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default, bool enableRangeProcessing = false);static member Stream : System.IO.Pipelines.PipeReader * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Http.IResultPublic Shared Function Stream (pipeReader As PipeReader, Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing, Optional enableRangeProcessing As Boolean = false) As IResultParameters
- pipeReader
- PipeReader
The PipeReader to write to the response.
- contentType
- String
The Content-Type of the response. Defaults to application/octet-stream.
- fileDownloadName
- String
The the file name to be used in the Content-Disposition header.
- lastModified
- Nullable<DateTimeOffset>
The DateTimeOffset of when the file was last modified.
Used to configure the Last-Modified response header and perform conditional range requests.
- entityTag
- EntityTagHeaderValue
The EntityTagHeaderValue to be configure the ETag response header
and perform conditional requests.
- enableRangeProcessing
- Boolean
Set to true to enable range requests processing.
Returns
The created IResult for the response.
Remarks
The pipeReader parameter is completed after the response is sent.
Applies to
Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)
Writes the specified Stream to the response.
This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
This API is an alias for File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).
public static Microsoft.AspNetCore.Http.IResult Stream (System.IO.Stream stream, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default, bool enableRangeProcessing = false);static member Stream : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Http.IResultPublic Shared Function Stream (stream As Stream, Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing, Optional enableRangeProcessing As Boolean = false) As IResultParameters
- contentType
- String
The Content-Type of the response. Defaults to application/octet-stream.
- fileDownloadName
- String
The the file name to be used in the Content-Disposition header.
- lastModified
- Nullable<DateTimeOffset>
The DateTimeOffset of when the file was last modified.
Used to configure the Last-Modified response header and perform conditional range requests.
- entityTag
- EntityTagHeaderValue
The EntityTagHeaderValue to be configure the ETag response header
and perform conditional requests.
- enableRangeProcessing
- Boolean
Set to true to enable range requests processing.
Returns
The created IResult for the response.
Remarks
The stream parameter is disposed after the response is sent.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for