Table of Contents

Namespace Nerdbank.Json

Classes

ConverterCollection

An immutable collection of concrete JSON converters.

JsonArray

An immutable JSON array.

JsonAsyncReader

An incremental UTF-8 JSON reader that decodes from a PipeReader without buffering the entire document.

JsonAsyncWriter

An incremental UTF-8 JSON writer that writes to a PipeWriter and flushes periodically so large object graphs can be serialized with bounded memory and cooperative backpressure.

JsonBoolean

A JSON boolean value.

JsonCollectionComparerAttribute

Selects the IEqualityComparer<T> or IComparer<T> that the deserializer uses when it constructs the collection for the decorated dictionary or set member.

JsonConverter

Base type for JSON converters.

JsonConverterAttribute

Applies a custom JsonConverter<T> to a type or serialized member.

JsonConverterTypeCollection

An immutable collection of JsonConverter<T> types.

JsonConverter<T>

Base type for JSON converters that handle a specific .NET type.

JsonExtensionDataAttribute

Indicates that a property or field should capture unrecognized JSON object members.

JsonNamingPolicy

Defines a transformation for property names from .NET to JSON.

JsonNull

The JSON null literal.

JsonNumber

A JSON number value that preserves the exact JSON token text so that no precision or formatting is lost.

JsonObject

An immutable JSON object that preserves member order.

JsonPath

An immutable, pre-parsed path that selects a single value within a JSON document for targeted deserialization.

JsonPathNotFoundException

The exception thrown when a targeted deserialization path selects a value that is not present in the document and Throw is in effect.

JsonSchema

A minimal, ordered JSON object model used to build JSON Schema documents without rooting System.Text.Json.

JsonSchemaContext

Drives generation of a JSON Schema document, resolving nested schemas, shared definitions, and recursive types. Provided to GetJsonSchema(JsonSchemaContext, ITypeShape) so custom converters can describe nested types consistently.

JsonSchemaOptions

Options for JSON Schema generation.

JsonSerializationException

Represents errors that occur during JSON serialization.

JsonSerializer

Serializes .NET values to JSON.

JsonSerializerExtensions

Extension methods for the JsonSerializer class.

JsonString

A JSON string value.

JsonUnionConfiguration

An immutable, serializer-scoped set of runtime overrides for polymorphic union (sub-type) serialization.

JsonUnion<TBase>

An immutable description of a polymorphic union for the base type TBase, built from explicitly supplied case type shapes.

JsonValue

A compact, immutable, native representation of an arbitrary JSON value, usable without a static model.

SecuritySettings

Security settings that may be applied to serialization.

Structs

JsonConverterFactoryContext

Provides converter lookup services while a IJsonConverterFactory is creating a converter.

JsonNavigationOptions

Options that flow through targeted-deserialization navigation.

JsonNavigationSegment

Identifies one step of a targeted-deserialization path: an object member (or dictionary entry) by serialized name, or an array element by index.

JsonReader

Reads JSON values from a UTF-8 byte buffer.

JsonWriter

Writes JSON values to a UTF-8 buffer.

SerializationContext

Context that flows through the serialization process.

Interfaces

IJsonConverterFactory

Creates JsonConverter instances for types discovered at runtime.

IJsonSerializationCallbacks

Receives notifications immediately before an object is serialized and after it is deserialized.

Enums

DeserializeDefaultValuesPolicy

Enumerates policies that control how deserialization handles default values.

JsonCommentHandling

Specifies how JSON comments are handled during deserialization.

JsonSchemaDialect

Identifies a supported JSON Schema dialect.

JsonSerializationException.ErrorCode

Specified causes for serialization or deserialization failure.

JsonValueKind

Identifies the kind of a JsonValue.

MissingPathBehavior

Controls what happens when a targeted deserialization path selects a value that is not present in the document.

ReferencePreservationMode

Controls whether reference equality is preserved in serialized object graphs.

SerializeDefaultValuesPolicy

Specifies the policy for serializing default values.