Utf8JsonWriter.WriteStartObject Method

Definition

Namespace: Corvus.Text.Json
Assembly: Corvus.Text.Json.dll

Overloads

Method	Description
WriteStartObject()	Writes the beginning of a JSON object.
WriteStartObject(JsonEncodedText)	Writes the beginning of a JSON object with a pre-encoded property name as the key.
WriteStartObject(ReadOnlySpan<byte>)	Writes the beginning of a JSON object with a property name as the key.
WriteStartObject(string)	Writes the beginning of a JSON object with a property name as the key.
WriteStartObject(ReadOnlySpan<char>)	Writes the beginning of a JSON object with a property name as the key.

WriteStartObject()

Source: Utf8JsonWriter.cs

Writes the beginning of a JSON object.

public void WriteStartObject()

Exceptions

Exception	Description
InvalidOperationException	Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in invalid JSON being written (while validation is enabled).

Applies To

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

---

WriteStartObject(JsonEncodedText)

Source: Utf8JsonWriter.cs

Writes the beginning of a JSON object with a pre-encoded property name as the key.

public void WriteStartObject(JsonEncodedText propertyName)

Parameters

Name	Type	Description
propertyName	JsonEncodedText	The JSON-encoded name of the property to write.

Exceptions

Exception	Description
InvalidOperationException	Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in invalid JSON being written (while validation is enabled).

Applies To

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

---

WriteStartObject(ReadOnlySpan<byte>)

Source: Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name as the key.

public void WriteStartObject(ReadOnlySpan<byte> utf8PropertyName)

Parameters

Name	Type	Description
utf8PropertyName	ReadOnlySpan<byte>	The UTF-8 encoded property name of the JSON object to be written.

Exceptions

Exception	Description
ArgumentException	Thrown when the specified property name is too large.
InvalidOperationException	Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in invalid JSON being written (while validation is enabled).

Remarks

The property name is escaped before writing.

Applies To

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

---

WriteStartObject(string)

Source: Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name as the key.

public void WriteStartObject(string propertyName)

Parameters

Name	Type	Description
propertyName	string	The name of the property to write.

Exceptions

Exception	Description
ArgumentException	Thrown when the specified property name is too large.
ArgumentNullException	The propertyName parameter is null.
InvalidOperationException	Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in invalid JSON being written (while validation is enabled).

Remarks

The property name is escaped before writing.

Applies To

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

---

WriteStartObject(ReadOnlySpan<char>)

Source: Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name as the key.

public void WriteStartObject(ReadOnlySpan<char> propertyName)

Parameters

Name	Type	Description
propertyName	ReadOnlySpan<char>	The name of the property to write.

Exceptions

Exception	Description
ArgumentException	Thrown when the specified property name is too large.
InvalidOperationException	Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in invalid JSON being written (while validation is enabled).

Remarks

The property name is escaped before writing.

Applies To

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

---