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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add weakly typed Serialize and Deserialize overloads accepting JsonTypeInfo. by eiriktsarpalis · Pull Request #79397 · dotnet/runtime · GitHub
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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