Utf8JsonReader Struct (System.Text.Json) (2024)

Utf8JsonReader processes the text sequentially with no caching and by default adheres strictly to the JSON RFC.

When Utf8JsonReader encounters invalid JSON, it throws a JsonException with basic error information like line number and byte position on the line.

Since this type is a ref struct, it doesn't directly support async. However, it does provide support for reentrancy to read incomplete data and to continue reading once more data is presented.

To be able to set max depth while reading or to allow skipping comments, create an instance of JsonReaderOptions and pass it to the reader.

CopyString(Span<Byte>)

Copies the current JSON token value from the source, unescaped, as UTF-8 bytes to a buffer.

CopyString(Span<Char>)

Copies the current JSON token value from the source, unescaped, as UTF-16 characters to a buffer.

GetBoolean()

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

GetByte()

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

GetBytesFromBase64()

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

GetComment()

Parses the current JSON token value from the source as a comment and transcodes it as a String.

GetDateTime()

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

GetUInt32()

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

GetUInt64()

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

Read()

Reads the next JSON token from the input source.

Skip()

Skips the children of the current JSON token.

TryGetByte(Byte)

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

TryGetBytesFromBase64(Byte[])

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.

TryGetDateTime(DateTime)

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

TryGetDateTimeOffset(DateTimeOffset)

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

TryGetDecimal(Decimal)

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

TryGetDouble(Double)

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

TryGetGuid(Guid)

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

TryGetInt16(Int16)

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

TryGetInt32(Int32)

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

TryGetInt64(Int64)

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

TryGetSByte(SByte)

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

TryGetSingle(Single)

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

TryGetUInt16(UInt16)

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

TryGetUInt32(UInt32)

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

TryGetUInt64(UInt64)

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

TrySkip()

Tries to skip the children of the current JSON token.

ValueTextEquals(ReadOnlySpan<Byte>)

Compares the UTF-8 encoded text in a read-only byte span to the unescaped JSON token value in the source and returns a value that indicates whether they match.

ValueTextEquals(ReadOnlySpan<Char>)

Compares the text in a read-only character span to the unescaped JSON token value in the source and returns a value that indicates whether they match.

ValueTextEquals(String)

Compares the string text to the unescaped JSON token value in the source and returns a value that indicates whether they match.