Поделиться через

Results.Stream Метод

  • Ссылка

Определение

Пространство имен:
Microsoft.AspNetCore.Http
Сборка:
Microsoft.AspNetCore.Http.Results.dll
Пакет:
Microsoft.AspNetCore.App.Ref v7.0.5
Пакет:
Microsoft.AspNetCore.App.Ref v8.0.0
Пакет:
Microsoft.AspNetCore.App.Ref v9.0.0-preview.6.24328.4
Пакет:
Microsoft.AspNetCore.App.Ref v6.0.6

Перегрузки

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)

Исходный код:
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

EntityTagHeaderValue для настройки заголовка ответа ETag и выполнения условных запросов.

Возвращаемое значение

IResult

Созданный IResult для ответа.

Применяется к

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

Исходный код:
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

EntityTagHeaderValue для настройки заголовка ответа ETag и выполнения условных запросов.

enableRangeProcessing
Boolean

Установите значение true, чтобы включить обработку запросов диапазона.

Возвращаемое значение

IResult

Созданный IResult для ответа.

Комментарии

После отправки ответа параметр pipeReader завершается.

Применяется к

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

Исходный код:
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

EntityTagHeaderValue для настройки заголовка ответа ETag и выполнения условных запросов.

enableRangeProcessing
Boolean

Установите значение true, чтобы включить обработку запросов диапазона.

Возвращаемое значение

IResult

Созданный IResult для ответа.

Комментарии

Параметр stream удаляется после отправки ответа.

Применяется к