ParsedJsonDocument<T>

Definition

Namespace: Corvus.Text.Json
Assembly: Corvus.Text.Json.dll
Source: ParsedJsonDocument.cs

Represents the structure of a JSON value in a lightweight, read-only form.

public sealed class ParsedJsonDocument<T> : JsonDocument, IJsonDocument, IDisposable
    where T : struct, IJsonElement<T>

Remarks

This class utilizes resources from pooled memory to minimize the garbage collector (GC) impact in high-usage scenarios. Failure to properly Dispose this object will result in the memory not being returned to the pool, which will cause an increase in GC impact across various parts of the framework.

Inheritance

Object → JsonDocument → ParsedJsonDocument

Implements

IJsonDocument, IDisposable

Properties

Methods

Examples

The following example parses a JSON document from a string and accesses typed properties on the root element.

using ParsedJsonDocument<Person> doc =
    ParsedJsonDocument<Person>.Parse(jsonString);
Person person = doc.RootElement;

string familyName = (string)person.FamilyName;

You can also parse from UTF-8 bytes, which avoids the cost of transcoding from UTF-16:

using ParsedJsonDocument<Person> doc =
    ParsedJsonDocument<Person>.Parse(utf8Bytes);

The returned document implements IDisposable and must be disposed to return pooled memory. Always use a using statement or using declaration:

using ParsedJsonDocument<Person> doc =
    ParsedJsonDocument<Person>.Parse(jsonString);
Person person = doc.RootElement;

// Work with person...

// Memory is returned when 'doc' is disposed at the end of the scope

Applies To