HttpContentJsonExtensions.ReadFromJsonAsAsyncEnumerable 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
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, CancellationToken) |
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation. |
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, JsonSerializerOptions, CancellationToken) |
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation. |
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, JsonTypeInfo<TValue>, CancellationToken) |
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation. |
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, CancellationToken)
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation.
public static System.Collections.Generic.IAsyncEnumerable<TValue?> ReadFromJsonAsAsyncEnumerable<TValue> (this System.Net.Http.HttpContent content, System.Threading.CancellationToken cancellationToken = default);
static member ReadFromJsonAsAsyncEnumerable : System.Net.Http.HttpContent * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Value>
<Extension()>
Public Function ReadFromJsonAsAsyncEnumerable(Of TValue) (content As HttpContent, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TValue)
Type Parameters
- TValue
The target type to deserialize to.
Parameters
- content
- HttpContent
- cancellationToken
- CancellationToken
Returns
An IAsyncEnumerable<T> that represents the deserialized response body.
Exceptions
The content
is null
.
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, JsonSerializerOptions, CancellationToken)
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation.
public static System.Collections.Generic.IAsyncEnumerable<TValue?> ReadFromJsonAsAsyncEnumerable<TValue> (this System.Net.Http.HttpContent content, System.Text.Json.JsonSerializerOptions? options, System.Threading.CancellationToken cancellationToken = default);
static member ReadFromJsonAsAsyncEnumerable : System.Net.Http.HttpContent * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Value>
<Extension()>
Public Function ReadFromJsonAsAsyncEnumerable(Of TValue) (content As HttpContent, options As JsonSerializerOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TValue)
Type Parameters
- TValue
The target type to deserialize to.
Parameters
- content
- HttpContent
The content to read from.
- options
- JsonSerializerOptions
Options to control the behavior during deserialization. The default options are those specified by Web.
- cancellationToken
- CancellationToken
Returns
An IAsyncEnumerable<T> that represents the deserialized response body.
Exceptions
The content
is null
.
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
ReadFromJsonAsAsyncEnumerable<TValue>(HttpContent, JsonTypeInfo<TValue>, CancellationToken)
Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation.
public static System.Collections.Generic.IAsyncEnumerable<TValue?> ReadFromJsonAsAsyncEnumerable<TValue> (this System.Net.Http.HttpContent content, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);
static member ReadFromJsonAsAsyncEnumerable : System.Net.Http.HttpContent * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Value>
<Extension()>
Public Function ReadFromJsonAsAsyncEnumerable(Of TValue) (content As HttpContent, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TValue)
Type Parameters
- TValue
The target type to deserialize to.
Parameters
- content
- HttpContent
The content to read from.
- jsonTypeInfo
- JsonTypeInfo<TValue>
The JsonTypeInfo used to control the deserialization behavior.
- cancellationToken
- CancellationToken
Returns
An IAsyncEnumerable<T> that represents the deserialized response body.
Exceptions
The content
is null
.
The cancellation token was canceled. This exception is stored into the returned task.