JsonDocumentBuilder<T>

Definition

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

A mutable JSON document builder that provides functionality to construct and modify JSON documents.

public sealed class JsonDocumentBuilder<T> : JsonDocument, IMutableJsonDocument, IWorkspaceManagedDocument, IJsonDocument, IDisposable
    where T : struct, IMutableJsonElement<T>

Type Parameters

Inheritance

Object → JsonDocument → JsonDocumentBuilder

Implements

IMutableJsonDocument, IWorkspaceManagedDocument, IJsonDocument, IDisposable

Properties

Methods

Examples

The following example creates a mutable builder from a parsed document, modifies properties, and serializes the result.

using JsonWorkspace workspace = JsonWorkspace.Create();
using ParsedJsonDocument<Person> doc =
    ParsedJsonDocument<Person>.Parse(
        """
        {
          "name": { "familyName": "Oldroyd", "givenName": "Michael" },
          "age": 30
        }
        """);
using var builder = doc.RootElement.CreateBuilder(workspace);

Person.Mutable root = builder.RootElement;
root.SetAge(31);
root.SetEmail("michael@example.com"u8);

Console.WriteLine(root.ToString());
// {"name":{"familyName":"Oldroyd","givenName":"Michael"},"age":31,"email":"michael@example.com"}

If you intend to mutate immediately, you can skip the intermediate ParsedJsonDocument and parse directly into a builder for better performance:

using JsonWorkspace workspace = JsonWorkspace.Create();

using var builder = JsonDocumentBuilder<Person.Mutable>.Parse(
    workspace,
    """
    {
      "name": { "familyName": "Oldroyd", "givenName": "Michael" },
      "age": 30
    }
    """);

Person.Mutable root = builder.RootElement;
root.SetAge(31);
root.SetEmail("michael@example.com"u8);

Console.WriteLine(root.ToString());
// {"name":{"familyName":"Oldroyd","givenName":"Michael"},"age":31,"email":"michael@example.com"}

You can also build a document from scratch using the convenience CreateBuilder() overload with named parameters:

using JsonWorkspace workspace = JsonWorkspace.Create();

using var builder = Person.CreateBuilder(
    workspace,
    name: Person.PersonNameEntity.Build(
        (ref nb) => nb.Create(familyName: "Oldroyd"u8, givenName: "Michael"u8)),
    age: 30,
    email: "michael@example.com"u8);

Console.WriteLine(builder.RootElement.ToString());

Applies To