JsonSerializer.DeserializeAsyncEnumerable 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
| DeserializeAsyncEnumerable(Stream, JsonTypeInfo, CancellationToken) | |
| DeserializeAsyncEnumerable(Stream, Type, JsonSerializerOptions, CancellationToken) | |
| DeserializeAsyncEnumerable<TValue>(Stream, JsonSerializerOptions, CancellationToken) |
Wraps the UTF-8 encoded text into an IAsyncEnumerable<T> that can be used to deserialize root-level JSON arrays in a streaming manner. |
| DeserializeAsyncEnumerable<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken) |
Wraps the UTF-8 encoded text into an IAsyncEnumerable<T> that can be used to deserialize root-level JSON arrays in a streaming manner. |
DeserializeAsyncEnumerable(Stream, JsonTypeInfo, CancellationToken)
public static System.Collections.Generic.IAsyncEnumerable<object?> DeserializeAsyncEnumerable (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsyncEnumerable : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<obj>Public Function DeserializeAsyncEnumerable (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Object)Parameters
- utf8Json
- Stream
- jsonTypeInfo
- JsonTypeInfo
- cancellationToken
- CancellationToken
Returns
Applies to
DeserializeAsyncEnumerable(Stream, Type, JsonSerializerOptions, CancellationToken)
public static System.Collections.Generic.IAsyncEnumerable<object?> DeserializeAsyncEnumerable (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsyncEnumerable : System.IO.Stream * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<obj>Public Function DeserializeAsyncEnumerable (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Object)Parameters
- utf8Json
- Stream
- returnType
- Type
- options
- JsonSerializerOptions
- cancellationToken
- CancellationToken
Returns
Applies to
DeserializeAsyncEnumerable<TValue>(Stream, JsonSerializerOptions, CancellationToken)
Wraps the UTF-8 encoded text into an IAsyncEnumerable<T> that can be used to deserialize root-level JSON arrays in a streaming manner.
public static System.Collections.Generic.IAsyncEnumerable<TValue?> DeserializeAsyncEnumerable<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsyncEnumerable : System.IO.Stream * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Value>Public Function DeserializeAsyncEnumerable(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TValue)Type Parameters
- TValue
The element type to deserialize asynchronously.
Parameters
- utf8Json
- Stream
JSON data to parse.
- options
- JsonSerializerOptions
Options to control the behavior during reading.
- cancellationToken
- CancellationToken
The CancellationToken which may be used to cancel the read operation.
Returns
- IAsyncEnumerable<TValue>
An IAsyncEnumerable<T> representation of the provided JSON array.
Exceptions
utf8Json is null.
Applies to
DeserializeAsyncEnumerable<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken)
Wraps the UTF-8 encoded text into an IAsyncEnumerable<T> that can be used to deserialize root-level JSON arrays in a streaming manner.
public static System.Collections.Generic.IAsyncEnumerable<TValue?> DeserializeAsyncEnumerable<TValue> (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsyncEnumerable : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Value>Public Function DeserializeAsyncEnumerable(Of TValue) (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TValue)Type Parameters
- TValue
The element type to deserialize asynchronously.
Parameters
- utf8Json
- Stream
JSON data to parse.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadata about the element type to convert.
- cancellationToken
- CancellationToken
The CancellationToken that can be used to cancel the read operation.
Returns
- IAsyncEnumerable<TValue>
An IAsyncEnumerable<T> representation of the provided JSON array.
Exceptions
utf8Json or jsonTypeInfo is null.