System.Text.Json

Defines how the struct handles comments.

Allows comments within the JSON input and treats them as valid tokens. While reading, the caller can access the comment values.

Doesn't allow comments within the JSON input. Comments are treated as invalid JSON if found, and a is thrown. This is the default value.

Allows comments within the JSON input and ignores them. The behaves as if no comments are present.

Provides a mechanism for examining the structural content of a JSON value without automatically instantiating data values.

Releases the resources used by this instance.

Parses a sequence as UTF-8-encoded text representing a single JSON byte value into a JsonDocument.

The JSON text to parse. Options to control the reader behavior during parsing. does not represent a valid single JSON value. contains unsupported options. A JsonDocument representation of the JSON value.

Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion.

The JSON data to parse. Options to control the reader behavior during parsing. does not represent a valid single JSON value. contains unsupported options. A JsonDocument representation of the JSON value.

Parses memory as UTF-8-encoded text representing a single JSON byte value into a JsonDocument.

Parses text representing a single JSON character value into a JsonDocument.

Parses text representing a single JSON string value into a JsonDocument.

Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion.

The JSON data to parse. Options to control the reader behavior during parsing. The token to monitor for cancellation requests. does not represent a valid single JSON value. contains unsupported options. A task to produce a JsonDocument representation of the JSON value.

Parses one JSON value (including objects or arrays) from the provided reader.

The reader to read. contains unsupported options. -or- The current token does not start or represent a value. A value could not be read from the reader. A JsonDocument representing the value (and nested values) read from the reader.

Attempts to parse one JSON value (including objects or arrays) from the provided reader.

The reader to read. When the method returns, contains the parsed document. contains unsupported options. -or- The current token does not start or represent a value. A value could not be read from the reader. if a value was read and parsed into a JsonDocument; if the reader ran out of data while parsing. All other situations result in an exception being thrown.

Writes the document to the provided writer as a JSON value.

The writer to which to write the document. The parameter is . The of this would result in invalid JSON. The parent has been disposed.

Gets the root element of this JSON document.

A representing the value of the document.

Provides the ability for the user to define custom behavior when parsing JSON to create a .

Gets or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.

if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, . Default is

Gets or sets a value that determines how the handles comments when reading through the JSON data.

The comment handling enum is set to a value that is not supported (or not within the enum range). One of the enumeration values that indicates how comments are handled.

Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64.

The max depth is set to a negative value. The maximum depth allowed when parsing JSON data.

Represents a specific JSON value within a .

Gets a JsonElement that can be safely stored beyond the lifetime of the original .

A JsonElement that can be safely stored beyond the lifetime of the original .

Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement.

This value's is not . The parent has been disposed. An enumerator to enumerate the values in the JSON array represented by this JsonElement.

Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement.

This value's is not . The parent has been disposed. An enumerator to enumerate the properties in the JSON object represented by this JsonElement.

Gets the number of values contained within the current array value.

This value's is not . The parent has been disposed. The number of values contained within the current array value.

Gets the value of the element as a .

This value's is neither nor . The parent has been disposed. The value of the element as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the value of the element as a byte array.

This value's is not . The value is not encoded as Base64 text and hence cannot be decoded to bytes. The parent has been disposed. The value decoded as a byte array.

Gets the value of the element as a .

This value's is not . The value cannot be read as a . The parent has been disposed. The value of the element as a .

Gets the value of the element as a .

This value's is not . The value cannot be read as a . The parent has been disposed. The value of the element as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the value of the element as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The value of the element as a .

Gets the current JSON number as an .

This value's is not . The value cannot be represented as an . The parent has been disposed. The current JSON number as an .

Gets the current JSON number as an .

This value's is not . The value cannot be represented as an . The parent has been disposed. The current JSON number as an .

Gets the current JSON number as an .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as an .

Gets a representing the value of a required property identified by .

The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return. This value's is not . No property was found with the requested name. The parent has been disposed. A representing the value of the requested property.

Gets a representing the value of a required property identified by .

The name of the property whose value is to be returned. This value's is not . No property was found with the requested name. The parent has been disposed. A representing the value of the requested property.

Gets a representing the value of a required property identified by .

The name of the property whose value is to be returned. This value's is not . No property was found with the requested name. is . The parent has been disposed. A representing the value of the requested property.

Gets a string that represents the original input data backing this value.

The parent has been disposed. The original input data backing this value.

Gets the current JSON number as an .

This value's is not . The value cannot be represented as an . The parent has been disposed. The current JSON number as an .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the value of the element as a .

This value's is neither nor . The parent has been disposed. The value of the element as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets the current JSON number as a .

This value's is not . The value cannot be represented as a . The parent has been disposed. The current JSON number as a .

Gets a string representation for the current value appropriate to the value type.

The parent has been disposed. A string representation for the current value appropriate to the value type.

Attempts to represent the current JSON number as a .

When the method returns, contains the byte equivalent of the current JSON number if the conversion succeeded. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded.

If the method succeeds, contains the decoded binary representation of the Base64 text. This value's is not . The parent has been disposed. if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, .

Attempts to represent the current JSON string as a .

When this method returns, contains the date and time value equivalent to the current JSON string. This value's is not . The parent has been disposed. if the string can be represented as a ; otherwise, .

Attempts to represent the current JSON string as a .

When this method returns, contains the date and time equivalent to the current JSON string. This value's is not . The parent has been disposed. if the string can be represented as a ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains the decimal equivalent of the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains a double-precision floating point value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON string as a .

When this method returns, contains the GUID equivalent to the current JSON string. This value's is not . The parent has been disposed. if the string can be represented as a ; otherwise, .

Attempts to represent the current JSON number as an .

When the method returns, contains the 16-bit integer equivalent of the current JSON number if the conversion succeeded. This value's is not . The parent has been disposed. if the number can be represented as an ; otherwise, .

Attempts to represent the current JSON number as an .

When this method returns, contains the 32-biut integer value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as an ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains the 64-bit integer value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument.

The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. Receives the value of the located property. This value's is not . The parent has been disposed. if the property was found; otherwise, .

Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument.

The name of the property to find. When this method returns, contains the value of the specified property. This value's is not . The parent has been disposed. if the property was found; otherwise, .

Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, its value is assigned to the argument.

The name of the property to find. When this method returns, contains the value of the specified property. This value's is not . is . The parent has been disposed. if the property was found; otherwise, .

Attempts to represent the current JSON number as an .

When the method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded. This value's is not . The parent has been disposed. if the number can be represented as an ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains the single-precision floating point value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON number as a .

When the method returns, contains the unsigned 16-bit integer equivalent of the current JSON number if the conversion succeeded. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Attempts to represent the current JSON number as a .

When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number. This value's is not . The parent has been disposed. if the number can be represented as a ; otherwise, .

Compares the text represented by a UTF8-encoded byte span to the string value of this element.

The UTF-8 encoded text to compare against. This value's is not . if the string value of this element has the same UTF-8 encoding as ; otherwise, .

Compares a specified read-only character span to the string value of this element.

The text to compare against. This value's is not . if the string value of this element matches ; otherwise, .

Compares a specified string to the string value of this element.

The text to compare against. This value's is not . if the string value of this element matches ; otherwise, .

Writes the element to the specified writer as a JSON value.

The writer to which to write the element. The parameter is . The of this value is . The parent has been disposed.

Gets the value at the specified index if the current value is an .

The item index. This value's is not . is not in the range [0, ()). The parent has been disposed. The value at the specified index.

Gets the type of the current JSON value.

The parent has been disposed. The type of the current JSON value.

Represents an enumerator for the contents of a JSON array.

Releases the resources used by this instance.

Returns an enumerator that iterates through a collection.

An enumerator that can be used to iterate through the array.

Advances the enumerator to the next element of the collection.

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection.

Sets the enumerator to its initial position, which is before the first element in the collection.

Returns an enumerator that iterates through a collection.

An enumerator for an array of that can be used to iterate through the collection.

Returns an enumerator that iterates through a collection.

An enumerator that can be used to iterate through the collection.

Gets the element in the collection at the current position of the enumerator.

The element in the collection at the current position of the enumerator.

Gets the element in the collection at the current position of the enumerator.

The element in the collection at the current position of the enumerator.

Represents an enumerator for the properties of a JSON object.

Releases the resources used by this instance.

Returns an enumerator that iterates the properties of an object.

An enumerator that can be used to iterate through the object.

Advances the enumerator to the next element of the collection.

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection.

Sets the enumerator to its initial position, which is before the first element in the collection.

Returns an enumerator that iterates through a collection.

An enumerator for objects that can be used to iterate through the collection.

Returns an enumerator that iterates through a collection.

An enumerator that can be used to iterate through the collection.

Gets the element in the collection at the current position of the enumerator.

The element in the collection at the current position of the enumerator.

Gets the element in the collection at the current position of the enumerator.

The element in the collection at the current position of the enumerator.

Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON.

Encodes a UTF-8 text value as a JSON string.

The UTF-8 encoded text to convert to JSON encoded text. The encoder to use when escaping the string, or to use the default encoder. is too large. -or- contains invalid UTF-8 bytes. The encoded JSON text.

Encodes a specified text value as a JSON string.

The value to convert to JSON encoded text. The encoder to use when escaping the string, or to use the default encoder. is too large. -or- contains invalid UTF-16 characters. The encoded JSON text.

Encodes the string text value as a JSON string.

The value to convert to JSON encoded text. The encoder to use when escaping the string, or to use the default encoder. is . is too large. -or- contains invalid UTF-16 characters. The encoded JSON text.

Determines whether this instance and a specified object, which must also be a instance, have the same value.

The object to compare to this instance. if the current instance and are equal; otherwise, .

Determines whether this instance and another specified instance have the same value.

The object to compare to this instance. if this instance and have the same value; otherwise, .

Returns the hash code for this .

The hash code for this instance.

Converts the value of this instance to a .

The underlying UTF-16 encoded string.

Gets the UTF-8 encoded representation of the pre-encoded JSON text.

The UTF-8 encoded representation of the pre-encoded JSON text.

Defines a custom exception object that is thrown when invalid JSON text is encountered, when the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object.

Initializes a new instance of the class.

Creates a new exception object with serialized data.

The serialized object data about the exception being thrown. An object that contains contextual information about the source or destination. is .

Initializes a new instance of the class with a specified error message.

The context-specific error message.

Initializes a new instance of the class, with a specified error message and a reference to the inner exception that is the cause of this exception.

The context-specific error message. The exception that caused the current exception.

Creates a new exception object to relay error information to the user.

The context-specific error message. The path where the invalid JSON was encountered. The line number (starting at 0) at which the invalid JSON was encountered when deserializing. The byte count within the current line (starting at 0) where the invalid JSON was encountered.

Creates a new exception object to relay error information to the user that includes a specified inner exception.

The context-specific error message. The path where the invalid JSON was encountered. The line number (starting at 0) at which the invalid JSON was encountered when deserializing. The byte count (starting at 0) within the current line where the invalid JSON was encountered. The exception that caused the current exception.

Sets the with information about the exception.

The serialized object data about the exception being thrown. An object that contains contextual information about the source or destination.

Gets the zero-based number of bytes read within the current line before the exception.

The zero-based number of bytes read within the current line before the exception.

Gets the zero-based number of lines read before the exception.

The zero-based number of lines read before the exception.

Gets a message that describes the current exception.

The error message that describes the current exception.

Gets The path within the JSON where the exception was encountered.

The path within the JSON where the exception was encountered.

Determines the naming policy used to convert a string-based name to another format, such as a camel-casing format.

Initializes a new instance of .

When overridden in a derived class, converts the specified name according to the policy.

The name to convert. The converted name.

Gets the naming policy for camel-casing.

The naming policy for camel-casing.

Represents a single property for a JSON object.

Compares the specified UTF-8 encoded text to the name of this property.

The UTF-8 encoded text to compare against. This value's is not . if the name of this property has the same UTF-8 encoding as ; otherwise, .

Compares the specified text as a character span to the name of this property.

The text to compare against. This value's is not . if the name of this property matches ; otherwise, .

Compares the specified string to the name of this property.

The text to compare against. This value's is not . if the name of this property matches ; otherwise .

Provides a string representation of the property for debugging purposes.

A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value.

Writes the property to the provided writer as a named JSON object property.

The writer to which to write the property. is . is too large to be a JSON object property. The of this JSON property's would result in invalid JSON. The parent has been disposed.

Gets the name of this property.

The name of this property.

Gets the value of this property.

The value of this property.

Provides the ability for the user to define custom behavior when reading JSON.

Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.

if an extra comma is allowed; otherwise, .

Gets or sets a value that determines how the handles comments when reading through the JSON data.

The property is being set to a value that is not a member of the enumeration. One of the enumeration values that indicates how comments are handled.

Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64.

The maximum depth is being set to a negative value. The maximum depth allowed when reading JSON.

Defines an opaque type that holds and saves all the relevant state information, which must be provided to the to continue reading after processing incomplete data.

Constructs a new instance.

Defines the customized behavior of the that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64. The maximum depth is set to a non-positive value (< 0).

Gets the custom behavior to use when reading JSON data using the struct that may deviate from strict adherence to the JSON specification, which is the default behavior.

The custom behavior to use when reading JSON data.

Provides functionality to serialize objects or value types to JSON and to deserialize JSON into objects or value types.

Parses the UTF-8 encoded text representing a single JSON value into an instance of a specified type.

The JSON text to parse. The type of the object to convert to and return. Options to control the behavior during parsing. is . The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the span beyond a single JSON value. There is no compatible for or its serializable members. A representation of the JSON value.

Parses the text representing a single JSON value into an instance of a specified type.

The JSON text to parse. The type of the object to convert to and return. Options to control the behavior during parsing. or is . The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. A representation of the JSON value.

Reads one JSON value (including objects or arrays) from the provided reader and converts it into an instance of a specified type.

The reader to read the JSON from. The type of the object to convert to and return. Options to control the serializer behavior during reading. is . The JSON is invalid. -or- is not compatible with the JSON. -or- A value could not be read from the reader. is using unsupported options. There is no compatible for or its serializable members. A representation of the JSON value.

Parses the UTF-8 encoded text representing a single JSON value into an instance of the type specified by a generic type parameter.

The JSON text to parse. Options to control the behavior during parsing. The target type of the UTF-8 encoded text. The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the span beyond a single JSON value. There is no compatible for or its serializable members. A representation of the JSON value.

Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter.

The JSON text to parse. Options to control the behavior during parsing. The target type of the JSON value. is . The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. A representation of the JSON value.

Reads one JSON value (including objects or arrays) from the provided reader into an instance of the type specified by a generic type parameter.

The reader to read the JSON from. Options to control serializer behavior during reading. The target type of the JSON value. The JSON is invalid. -or- is not compatible with the JSON. -or- A value could not be read from the reader. uses unsupported options. There is no compatible for or its serializable members. A representation of the JSON value.

Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a specified type. The stream will be read to completion.

The JSON data to parse. The type of the object to convert to and return. Options to control the behavior during reading. A cancellation token that may be used to cancel the read operation. or is . The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the stream. There is no compatible for or its serializable members. A representation of the JSON value.

Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a type specified by a generic type parameter. The stream will be read to completion.

The JSON data to parse. Options to control the behavior during reading. A token that may be used to cancel the read operation. The target type of the JSON value. The JSON is invalid. -or- is not compatible with the JSON. -or- There is remaining data in the stream. There is no compatible for or its serializable members. is . A representation of the JSON value.

Converts the value of a specified type into a JSON string.

The value to convert. The type of the to convert. Options to control the conversion behavior. is not compatible with . is . There is no compatible for or its serializable members. The JSON string representation of the value.

Writes the JSON representation of the specified type to the provided writer.

The JSON writer to write to. The value to convert and write. The type of the to convert. Options to control serialization behavior. is not compatible with or is . There is no compatible for or its serializable members.

Converts the value of a type specified by a generic type parameter into a JSON string.

The value to convert. Options to control serialization behavior. The type of the value to serialize. There is no compatible for or its serializable members. A JSON string representation of the value.

Writes the JSON representation of a type specified by a generic type parameter to the provided writer.

A JSON writer to write to. The value to convert and write. Options to control serialization behavior. The type of the value to serialize. is . There is no compatible for or its serializable members.

Asynchronously converts the value of a specified type to UTF-8 encoded JSON text and writes it to the specified stream.

The UTF-8 stream to write to. The value to convert. The type of the to convert. Options to control serialization behavior. A token that may be used to cancel the write operation. is not compatible with . or is . There is no compatible for or its serializable members. A task that represents the asynchronous write operation.

Asynchronously converts a value of a type specified by a generic type parameter to UTF-8 encoded JSON text and writes it to a stream.

The UTF-8 stream to write to. The value to convert. Options to control serialization behavior. A token that may be used to cancel the write operation. The type of the value to serialize. is . There is no compatible for or its serializable members. A task that represents the asynchronous write operation.

Converts a value of the specified type into a JSON string, encoded as UTF-8 bytes.

The value to convert. The type of the to convert. Options to control the conversion behavior. is not compatible with . is . There is no compatible for or its serializable members. A JSON string representation of the value, encoded as UTF-8 bytes.

Converts the value of a type specified by a generic type parameter into a JSON string, encoded as UTF-8 bytes.

The value to convert. Options to control the conversion behavior. The type of the value. There is no compatible for or its serializable members. A JSON string representation of the value, encoded as UTF-8 bytes.

Specifies what default options are used by .

Specifies that general-purpose values should be used. These are the same settings applied if a isn't specified.

Specifies that values should be used more appropriate to web-based scenarios.

Provides options to be used with .

Initializes a new instance of the class.

Constructs a new instance with a predefined set of options determined by the specified .

The to reason about.

Copies the options from a instance to a new instance.

The options instance to copy options from. is .

Returns the converter for the specified type.

The type to return a converter for. The configured for returned an invalid converter. There is no compatible for or its serializable members. The first converter that supports the given type, or if there is no converter.

Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized.

This property was set after serialization or deserialization has occurred. if an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored); otherwise.

Gets the list of user-defined converters that were registered.

The list of custom converters.

Gets or sets the default buffer size, in bytes, to use when creating temporary buffers.

The buffer size is less than 1. This property was set after serialization or deserialization has occurred. The default buffer size in bytes.

Specifies a condition to determine when properties with default values are ignored during serialization or deserialization. The default value is .

This property is set to . This property is set after serialization or deserialization has occurred. -or- has been set to . These properties cannot be used together.

Gets or sets the policy used to convert a key's name to another format, such as camel-casing.

The policy used to convert a key's name to another format.

Gets or sets the encoder to use when escaping strings, or to use the default encoder.

The JavaScript character encoding.

Gets or sets a value that determines whether values are ignored during serialization and deserialization. The default value is .

This property was set after serialization or deserialization has occurred. -or- has been set to a non-default value. These properties cannot be used together. to ignore null values during serialization and deserialization; otherwise, see langword="false" />.

Determines whether read-only fields are ignored during serialization. A property is read-only if it isn't marked with the keyword. The default value is .

This property is set after serialization or deserialization has occurred. if read-only fields should be ignored during serialization; otherwise.

Gets a value that determines whether read-only properties are ignored during serialization. The default value is .

This property was set after serialization or deserialization has occurred. to ignore read-only properties during serialization; otherwise, .

Determines whether fields are handled serialization and deserialization. The default value is .

This property is set after serialization or deserialization has occurred.

Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64.

This property was set after serialization or deserialization has occurred. The max depth is set to a negative value. The maximum depth allowed when serializing or deserializing JSON.

Specifies how number types should be handled when serializing or deserializing.

This property is set after serialization or deserialization has occurred.

Gets or sets a value that determines whether a property's name uses a case-insensitive comparison during deserialization. The default value is .

to compare property names using case-insensitive comparison; otherwise, .

Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing, or to leave property names unchanged.

A property naming policy, or to leave property names unchanged.

Gets or sets a value that defines how comments are handled during deserialization.

This property was set after serialization or deserialization has occurred. The comment handling enum is set to a value that is not supported (or not within the enum range). A value that indicates whether comments are allowed, disallowed, or skipped.

Configures how object references are handled when reading and writing JSON.

Gets or sets a value that defines whether JSON should use pretty printing. By default, JSON is serialized without any extra white space.

This property was set after serialization or deserialization has occurred. if JSON should pretty print on serialization; otherwise, . The default is .

Defines the various JSON tokens that make up a JSON text.

The token type is a comment string.

The token type is the end of a JSON array.

The token type is the end of a JSON object.

The token type is the JSON literal false.

There is no value (as distinct from ).

The token type is the JSON literal null.

The token type is a JSON number.

The token type is a JSON property name.

The token type is the start of a JSON array.

The token type is the start of a JSON object.

The token type is a JSON string.

The token type is the JSON literal true.

Specifies the data type of a JSON value.

A JSON array.

The JSON value false.

The JSON value null.

A JSON number.

A JSON object.

A JSON string.

The JSON value true.

There is no value (as distinct from ).

Allows the user to define custom behavior when writing JSON using the .

Gets or sets the encoder to use when escaping strings, or to use the default encoder.

The JavaScript character encoder used to override the escaping behavior.

Gets or sets a value that indicates whether the should format the JSON output, which includes indenting nested JSON tokens, adding new lines, and adding white space between property names and values.

to format the JSON output; to write without any extra white space. The default is .

Gets or sets a value that indicates whether the should skip structural validation and allow the user to write invalid JSON.

to skip structural validation and allow invalid JSON; to throw an on any attempt to write invalid JSON.

Provides the base class for serialization attributes.

Creates a new instance of the .

When placed on a constructor, indicates that the constructor should be used to create instances of the type on deserialization.

Initializes a new instance of .

Converts an object or value to or from JSON.

When overridden in a derived class, determines whether the converter instance can convert the specified object type.

The type of the object to check whether it can be converted by this converter instance. if the instance can convert the specified object type; otherwise, .

Converts an object or value to or from JSON.

The type of object or value handled by the converter.

Initializes a new instance.

Determines whether the specified type can be converted.

The type to compare against. if the type can be converted; otherwise, .

Reads and converts the JSON to type .

The reader. The type to convert. An object that specifies serialization options to use. The converted value.

Writes a specified value as JSON.

The writer to write to. The value to convert to JSON. An object that specifies serialization options to use.

Indicates whether should be passed to the converter on serialization, and whether should be passed on deserialization.

When placed on a property or type, specifies the converter type to use.

Initializes a new instance of .

Initializes a new instance of with the specified converter type.

The type of the converter.

When overridden in a derived class and is , allows the derived class to create a in order to pass additional state.

The type of the converter. The custom converter.

Gets the type of the , or if it was created without a type.

The type of the , or if it was created without a type.

Supports converting several types by using a factory pattern.

When overidden in a derived class, initializes a new instance of the class.

Creates a converter for a specified type.

The type handled by the converter. The serialization options to use. A converter for which is compatible with .

When placed on a property of type , any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization.

Instantiates a new instance of the class.

Prevents a property from being serialized or deserialized.

Initializes a new instance of .

Specifies the condition that must be met before a property will be ignored.

Controls how the ignores properties on serialization and deserialization.

Property will always be ignored.

Property will always be serialized and deserialized, regardless of configuration.

Property will only be ignored if it is .

If the value is , the property is ignored during serialization. This is applied only to reference-type properties and fields.

Indicates that the member should be included for serialization and deserialization.

The attribute is applied to a non-public property.

Initializes a new instance of .

Determines how handles numbers when serializing and deserializing.

The "NaN", "Infinity", and "-Infinity" tokens can be read as floating-point constants, and the and values for these constants will be written as their corresponding JSON string representations.

Numbers can be read from tokens. Does not prevent numbers from being read from token.

Numbers will only be read from tokens and will only be written as JSON numbers (without quotes).

Numbers will be written as JSON strings (with quotes), not as JSON numbers.

When placed on a type, property, or field, indicates what settings should be used when serializing or deserializing numbers.

Initializes a new instance of .

A bitwise combination of the enumeration values that specify how number types should be handled when serializing or deserializing.

Indicates what settings should be used when serializing or deserializing numbers.

An object that determines the number serialization and deserialization settings.

Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by .

Initializes a new instance of with the specified property name.

The name of the property.

Gets the name of the property.

The name of the property.

Converts enumeration values to and from strings.

Initializes an instance of the class with the default naming policy that allows integer values.

Initializes an instance of the class with a specified naming policy and a value that indicates whether undefined enumeration values are allowed.

The optional naming policy for writing enum values. to allow undefined enum values; otherwise, . When , if an enum value isn't defined, it will output as a number rather than a string.

Determines whether the specified type can be converted to an enum.

The type to be checked. if the type can be converted; otherwise, .

Creates a converter for the specified type.

The type handled by the converter. The serialization options to use. A converter for which is compatible with .

This class defines how the deals with references on serialization and deserialization.

Initializes a new instance of the class.

Returns the used for each serialization call.

The resolver to use for serialization and deserialization.

Metadata properties will be honored when deserializing JSON objects and arrays into reference types and written when serializing reference types. This is necessary to create round-trippable JSON from objects that contain cycles or duplicate references.

This class defines how the deals with references on serialization and deserialization.

The type of the to create on each serialization or deserialization call.

Initializes a new instance of the generic class that can create a instance of the specified .

Creates a new of type used for each serialization call.

The new resolver to use for serialization and deserialization.

This class defines how the deals with references on serialization and deserialization. Defines the core behavior of preserving references on serialization and deserialization.

Initializes a new instance of the class.

Adds an entry to the bag of references using the specified id and value. This method gets called when an $id metadata property from a JSON object is read.

The identifier of the JSON object or array. The value of the CLR reference type object that results from parsing the JSON object.

Gets the reference identifier of the specified value if exists; otherwise a new id is assigned. This method gets called before a CLR object is written so we can decide whether to write $id and enumerate the rest of its properties or $ref and step into the next object.

The value of the CLR reference type object to get an id for. When this method returns, if a reference to value already exists; otherwise, . The reference id for the specified object.

Returns the CLR reference type object related to the specified reference id. This method gets called when $ref metadata property is read.

The reference id related to the returned object. The reference type object related to the specified reference id.

Provides a high-performance API for forward-only, read-only access to UTF-8 encoded JSON text.

Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text and indicates whether the input contains all the text to process.

The UTF-8 encoded JSON text to process. to indicate that the input sequence contains the entire data to process; to indicate that the input span contains partial data with more data to follow. An object that contains the reader state. If this is the first call to the constructor, pass the default state; otherwise, pass the value of the property from the previous instance of the .

Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text using the specified options.

The UTF-8 encoded JSON text to process. Defines customized behavior of the that differs from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64.

Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text and indicates whether the input contains all the text to process.

Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text using the specified options.

Reads the next JSON token value from the source as a .

The value of the JSON token isn't a boolean value (that is, or ). if the is ; if the is .

Parses the current JSON token value from the source as a .

The value of the JSON token is not a . The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). -or- The JSON token value represents a number less than or greater than . The value of the UTF-8 encoded token.

Parses the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array.

The type of the JSON token is not a . The value is not encoded as Base64 text, so it can't be decoded to bytes. -or- The value contains invalid or more than two padding characters. -or- The value is incomplete. That is, the JSON string length is not a multiple of 4. The byte array that represents the current JSON token value.

Parses the current JSON token value from the source as a comment, transcoded it as a .

The JSON token is not a comment. The comment that represents the current JSON token value.

Reads the next JSON token value from the source and parses it to a .

The value of the JSON token isn't a . The JSON token value cannot be read as a . -or- The entire UTF-8 encoded token value cannot be parsed to a value. -or- The JSON token value is of an unsupported format. The date and time value, if the entire UTF-8 encoded token value can be successfully parsed.

Reads the next JSON token value from the source and parses it to a .

The value of the JSON token isn't a . The JSON token value cannot be read as a . -or- The entire UTF-8 encoded token value cannot be parsed to a value. -or- The JSON token value is of an unsupported format. The date and time offset, if the entire UTF-8 encoded token value can be successfully parsed.

Reads the next JSON token value from the source and parses it to a .

The JSON token value isn't a . The JSON token value represents a number less than or greater than . The UTF-8 encoded token value parsed to a .

Reads the next JSON token value from the source and parses it to a .

The JSON token value isn't a . The JSON token value represents a number less than or greater than . The UTF-8 encoded token value parsed to a .

Reads the next JSON token value from the source and parses it to a .

The value of the JSON token isn't a . The JSON token value is in an unsupported format for a Guid. -or- The entire UTF-8 encoded token value cannot be parsed to a value. The GUID value, if the entire UTF-8 encoded token value can be successfully parsed.

Parses the current JSON token value from the source as a .

Reads the next JSON token value from the source and parses it to an .

The JSON token value isn't a . The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. -or- The JSON token value represents a number less than or greater than . The UTF-8 encoded token value parsed to an .

Reads the next JSON token value from the source and parses it to an .

Parses the current JSON token value from the source as an .

Reads the next JSON token value from the source and parses it to a .

The JSON token value isn't a . The JSON token value represents a number less than or greater than . The UTF-8 encoded token value parsed to a .

Reads the next JSON token value from the source, unescaped, and transcoded as a string.

The JSON token value isn't a string (that is, not a , , or ). -or- The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates. The token value parsed to a string, or if is .

Parses the current JSON token value from the source as a .

Reads the next JSON token value from the source and parses it to a .

Reads the next JSON token from the input source.

An invalid JSON token according to the JSON RFC is encountered. -or- The current depth exceeds the recursive limit set by the maximum depth. if the token was read successfully; otherwise, .

Skips the children of the current JSON token.

The reader was given partial data with more data to follow (that is, is ). An invalid JSON token was encountered while skipping, according to the JSON RFC. -or- The current depth exceeds the recursive limit set by the maximum depth.

Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded.

When this method returns, contains the parsed value. The JSON token value isn't a . if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, .

Tries to parse the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array and returns a value that indicates whether the operation succeeded.

When this method returns, contains the decoded binary representation of the Base64 text. The JSON token is not a . if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, .

Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded.

When this method returns, contains the parsed value. The value of the JSON token isn't a . if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, .