Results.Stream 方法

定义

命名空间:

Microsoft.AspNetCore.Http

程序集:

Microsoft.AspNetCore.Http.Results.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

重载

Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	允许直接写入响应正文。
Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	将指定 PipeReader 的内容写入响应。 这支持范围请求（如果范围不满足，Status206PartialContent 或 Status416RangeNotSatisfiable）。
Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	将指定的 Stream 写入响应。 这支持范围请求（如果范围不满足，Status206PartialContent 或 Status416RangeNotSatisfiable）。 此 API 是 File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)的别名。

Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:

Results.cs

允许直接写入响应正文。

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.IResult

Public 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 IResult

参数

streamWriterCallback

Func<Stream,Task>

允许用户直接写入响应正文的回调。

contentType

String

响应 Content-Type。 默认为 application/octet-stream。

fileDownloadName

String

要用于 Content-Disposition 标头的文件名。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。 用于配置 Last-Modified 响应标头并执行条件范围请求。

entityTag

EntityTagHeaderValue

要配置 ETag 响应标头并执行条件请求的 EntityTagHeaderValue。

返回

IResult

为响应创建的 IResult。

Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:

Results.cs

将指定 PipeReader 的内容写入响应。

这支持范围请求（如果范围不满足，Status206PartialContent 或 Status416RangeNotSatisfiable）。

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.IResult

Public 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 IResult

参数

pipeReader

PipeReader

要写入响应的 PipeReader。

contentType

String

响应 Content-Type。 默认为 application/octet-stream。

fileDownloadName

String

要用于 Content-Disposition 标头的文件名。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。 用于配置 Last-Modified 响应标头并执行条件范围请求。

entityTag

EntityTagHeaderValue

要配置 ETag 响应标头并执行条件请求的 EntityTagHeaderValue。

enableRangeProcessing

Boolean

设置为 true 以启用范围请求处理。

返回

IResult

为响应创建的 IResult。

注解

pipeReader 参数在发送响应后完成。

Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:

Results.cs

将指定的 Stream 写入响应。

这支持范围请求（如果范围不满足，Status206PartialContent 或 Status416RangeNotSatisfiable）。

此 API 是 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.IResult

Public 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 IResult

参数

stream

Stream

要写入响应的 Stream。

contentType

String

响应 Content-Type。 默认为 application/octet-stream。

fileDownloadName

String

要用于 Content-Disposition 标头的文件名。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。 用于配置 Last-Modified 响应标头并执行条件范围请求。

entityTag

EntityTagHeaderValue

要配置 ETag 响应标头并执行条件请求的 EntityTagHeaderValue。

enableRangeProcessing

Boolean

设置为 true 以启用范围请求处理。

返回

IResult

为响应创建的 IResult。

注解

发送响应后，将释放 stream 参数。