Skip to content
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.

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

The documentation on using Utf8JsonReader should explain how to obtain different kinds of objects from it, like e.g. JsonNode. #35021

Closed
konrad-jamrozik opened this issue Apr 15, 2023 · 0 comments · Fixed by #35883
Assignees
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-fundamentals/svc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@konrad-jamrozik
Copy link
Contributor

konrad-jamrozik commented Apr 15, 2023

As in subject, the section Use Utf8JsonReader should explain how it can be converted to different types. For example, one can convert it to JsonNode, by calling appropriate overload of JsonNode.Parse:

JsonNode? jsonNode = JsonNode.Parse(ref reader);

Ideally the doc would also explain how to get out of Utf8JsonReader in the simplest and most performant way:

  • JsonElement (e.g. JsonElement.ParseValue),
  • JsonDocument (e.g. JsonDocument.ParseValue)
  • and given custom type T (e.g. JsonSerializer.Deserialize<T>)

or link at least link to a document teaching the reader these types exists and how can be used together.

Related:


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 97027

@issues-automation issues-automation bot added dotnet-fundamentals/svc Pri1 High priority, do before Pri2 and Pri3 labels Apr 15, 2023
@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Apr 15, 2023
@gewarren gewarren self-assigned this May 18, 2023
@gewarren gewarren added the doc-enhancement Improve the current content [org][type][category] label May 18, 2023
@dotnet-bot dotnet-bot removed the ⌚ Not Triaged Not triaged label May 18, 2023
@gewarren gewarren added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Jun 2, 2023
@github-actions github-actions bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Jun 3, 2023
@ghost ghost added the in-pr This issue will be closed (fixed) by an active pull request. label Jun 20, 2023
@gewarren gewarren moved this from 🔖 Ready to 👀 In review in dotnet/docs June 2023 sprint Jun 20, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in dotnet/docs June 2023 sprint Jun 20, 2023
@ghost ghost removed the in-pr This issue will be closed (fixed) by an active pull request. label Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-fundamentals/svc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants