Skip to content

Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. #79397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eiriktsarpalis merged 1 commit into from
Dec 12, 2022
Merged

Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. #79397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions src/libraries/System.Text.Json/ref/System.Text.Json.cs
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 28 additions & 4 deletions ...aries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Document.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,6 @@ public static partial class JsonSerializer
/// <exception cref="JsonException">
/// <typeparamref name="TValue" /> is not compatible with the JSON.
/// </exception>
/// <exception cref="NotSupportedException">
/// There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter"/>
/// for <typeparamref name="TValue"/> or its serializable members.
/// </exception>
public static TValue? Deserialize<TValue>(this JsonDocument document, JsonTypeInfo<TValue> jsonTypeInfo)
{
if (document is null)
Expand All @@ -112,6 +108,34 @@ public static partial class JsonSerializer
return ReadFromSpan(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonDocument"/> representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// </summary>
/// <param name="document">The <see cref="JsonDocument"/> to convert.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="document"/> is <see langword="null"/>.
///
/// -or-
///
/// <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
public static object? Deserialize(this JsonDocument document, JsonTypeInfo jsonTypeInfo)
{
if (document is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(document));
}
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
ReadOnlySpan<byte> utf8Json = document.GetRootRawValue().Span;
return ReadFromSpanAsObject(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonDocument"/> representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
Expand Down
21 changes: 21 additions & 0 deletions ...raries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Element.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,27 @@ public static partial class JsonSerializer
return ReadFromSpan(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonElement"/> representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// </summary>
/// <returns>A <paramref name="jsonTypeInfo"/> representation of the JSON value.</returns>
/// <param name="element">The <see cref="JsonElement"/> to convert.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
public static object? Deserialize(this JsonElement element, JsonTypeInfo jsonTypeInfo)
{
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
ReadOnlySpan<byte> utf8Json = element.GetRawValue().Span;
return ReadFromSpanAsObject(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonElement"/> representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
Expand Down
24 changes: 20 additions & 4 deletions ...libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Node.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,6 @@ public static partial class JsonSerializer
/// <exception cref="JsonException">
/// <typeparamref name="TValue" /> is not compatible with the JSON.
/// </exception>
/// <exception cref="NotSupportedException">
/// There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter"/>
/// for <typeparamref name="TValue"/> or its serializable members.
/// </exception>
public static TValue? Deserialize<TValue>(this JsonNode? node, JsonTypeInfo<TValue> jsonTypeInfo)
{
if (jsonTypeInfo is null)
Expand All @@ -88,6 +84,26 @@ public static partial class JsonSerializer
return ReadFromNode(node, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonNode"/> representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// </summary>
/// <returns>A <paramref name="jsonTypeInfo"/> representation of the JSON value.</returns>
/// <param name="node">The <see cref="JsonNode"/> to convert.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
public static object? Deserialize(this JsonNode? node, JsonTypeInfo jsonTypeInfo)
{
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
return ReadFromNodeAsObject(node, jsonTypeInfo);
}

/// <summary>
/// Converts the <see cref="JsonNode"/> representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
Expand Down
27 changes: 22 additions & 5 deletions ...libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Span.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,7 @@ public static partial class JsonSerializer
/// <exception cref="JsonException">
/// The JSON is invalid,
/// <typeparamref name="TValue"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
/// <exception cref="NotSupportedException">
/// There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter"/>
/// for <typeparamref name="TValue"/> or its serializable members.
/// or when there is remaining data in the buffer.
/// </exception>
public static TValue? Deserialize<TValue>(ReadOnlySpan<byte> utf8Json, JsonTypeInfo<TValue> jsonTypeInfo)
{
Expand All @@ -93,6 +89,27 @@ public static partial class JsonSerializer
return ReadFromSpan(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Parses the UTF-8 encoded text representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// </summary>
/// <returns>A <paramref name="jsonTypeInfo"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON text to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="JsonException">
/// The JSON is invalid,
/// or there is remaining data in the buffer.
/// </exception>
public static object? Deserialize(ReadOnlySpan<byte> utf8Json, JsonTypeInfo jsonTypeInfo)
{
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
return ReadFromSpanAsObject(utf8Json, jsonTypeInfo);
}

/// <summary>
/// Parses the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
Expand Down
137 changes: 124 additions & 13 deletions ...braries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Stream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Runtime.CompilerServices;
using System.Text.Json.Serialization;
using System.Text.Json.Serialization.Converters;
using System.Text.Json.Serialization.Metadata;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -193,10 +190,6 @@ public static partial class JsonSerializer
/// <typeparamref name="TValue"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
/// <exception cref="NotSupportedException">
/// There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter"/>
/// for <typeparamref name="TValue"/> or its serializable members.
/// </exception>
public static ValueTask<TValue?> DeserializeAsync<TValue>(
Stream utf8Json,
JsonTypeInfo<TValue> jsonTypeInfo,
Expand All @@ -215,6 +208,41 @@ public static partial class JsonSerializer
return jsonTypeInfo.DeserializeAsync(utf8Json, cancellationToken);
}

/// <summary>
/// Reads the UTF-8 encoded text representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// The Stream will be read to completion.
/// </summary>
/// <returns>A <paramref name="jsonTypeInfo"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <param name="cancellationToken">
/// The <see cref="System.Threading.CancellationToken"/> that can be used to cancel the read operation.
/// </param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> or <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="JsonException">
/// The JSON is invalid,
/// or when there is remaining data in the Stream.
/// </exception>
public static ValueTask<object?> DeserializeAsync(
Stream utf8Json,
JsonTypeInfo jsonTypeInfo,
CancellationToken cancellationToken = default)
{
if (utf8Json is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(utf8Json));
}
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
return jsonTypeInfo.DeserializeAsObjectAsync(utf8Json, cancellationToken);
}

/// <summary>
/// Reads the UTF-8 encoded text representing a single JSON value into a <typeparamref name="TValue"/>.
/// The Stream will be read to completion.
Expand All @@ -231,10 +259,6 @@ public static partial class JsonSerializer
/// <typeparamref name="TValue"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
/// <exception cref="NotSupportedException">
/// There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter"/>
/// for <typeparamref name="TValue"/> or its serializable members.
/// </exception>
public static TValue? Deserialize<TValue>(
Stream utf8Json,
JsonTypeInfo<TValue> jsonTypeInfo)
Expand All @@ -252,6 +276,37 @@ public static partial class JsonSerializer
return jsonTypeInfo.Deserialize(utf8Json);
}

/// <summary>
/// Reads the UTF-8 encoded text representing a single JSON value into an instance specified by the <paramref name="jsonTypeInfo"/>.
/// The Stream will be read to completion.
/// </summary>
/// <returns>A <paramref name="jsonTypeInfo"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> or <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="JsonException">
/// The JSON is invalid,
/// or when there is remaining data in the Stream.
/// </exception>
public static object? Deserialize(
Stream utf8Json,
JsonTypeInfo jsonTypeInfo)
{
if (utf8Json is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(utf8Json));
}
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
return jsonTypeInfo.DeserializeAsObject(utf8Json);
}

/// <summary>
/// Reads the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// The Stream will be read to completion.
Expand Down Expand Up @@ -357,7 +412,6 @@ public static partial class JsonSerializer
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="options">Options to control the behavior during reading.</param>
/// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> that can be used to cancel the read operation.</param>
/// <returns>An <typeparamref name="TValue"/> representation of the JSON value.</returns>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> is <see langword="null"/>.
/// </exception>
Expand Down Expand Up @@ -386,7 +440,6 @@ public static partial class JsonSerializer
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the element type to convert.</param>
/// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> that can be used to cancel the read operation.</param>
/// <returns>An <typeparamref name="TValue"/> representation of the JSON value.</returns>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> or <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
Expand All @@ -408,5 +461,63 @@ public static partial class JsonSerializer
jsonTypeInfo.EnsureConfigured();
return jsonTypeInfo.DeserializeAsyncEnumerable(utf8Json, cancellationToken);
}

/// <summary>
/// Wraps the UTF-8 encoded text into an <see cref="IAsyncEnumerable{Object}" />
/// that can be used to deserialize root-level JSON arrays in a streaming manner.
/// </summary>
/// <returns>An <see cref="IAsyncEnumerable{Object}" /> representation of the provided JSON array.</returns>
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="returnType">The type of the object to convert to and return.</param>
/// <param name="options">Options to control the behavior during reading.</param>
/// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> that can be used to cancel the read operation.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> or <paramref name="returnType"/> is <see langword="null"/>.
/// </exception>
[RequiresUnreferencedCode(SerializationUnreferencedCodeMessage)]
[RequiresDynamicCode(SerializationRequiresDynamicCodeMessage)]
public static IAsyncEnumerable<object?> DeserializeAsyncEnumerable(
Stream utf8Json,
Type returnType,
JsonSerializerOptions? options = null,
CancellationToken cancellationToken = default)
{
if (utf8Json is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(utf8Json));
}

JsonTypeInfo jsonTypeInfo = GetTypeInfo(options, returnType);
return jsonTypeInfo.DeserializeAsyncEnumerableAsObject(utf8Json, cancellationToken);
}

/// <summary>
/// Wraps the UTF-8 encoded text into an <see cref="IAsyncEnumerable{Object}" />
/// that can be used to deserialize root-level JSON arrays in a streaming manner.
/// </summary>
/// <returns>An <see cref="IAsyncEnumerable{Object}" /> representation of the provided JSON array.</returns>
/// <param name="utf8Json">JSON data to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the element type to convert.</param>
/// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> that can be used to cancel the read operation.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="utf8Json"/> or <paramref name="jsonTypeInfo"/> is <see langword="null"/>.
/// </exception>
public static IAsyncEnumerable<object?> DeserializeAsyncEnumerable(
Stream utf8Json,
JsonTypeInfo jsonTypeInfo,
CancellationToken cancellationToken = default)
{
if (utf8Json is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(utf8Json));
}
if (jsonTypeInfo is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(jsonTypeInfo));
}

jsonTypeInfo.EnsureConfigured();
return jsonTypeInfo.DeserializeAsyncEnumerableAsObject(utf8Json, cancellationToken);
}
}
}
Loading