Utf8JsonReader Utf8JsonReader Utf8JsonReader Utf8JsonReader Struct

Определение

Предоставляет высокопроизводительный API для однонаправленного доступа только для чтения к тексту JSON в кодировке UTF-8.Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text.

public value class Utf8JsonReader
public struct Utf8JsonReader
type Utf8JsonReader = struct
Public Structure Utf8JsonReader
Наследование
Utf8JsonReaderUtf8JsonReaderUtf8JsonReaderUtf8JsonReader

Комментарии

Utf8JsonReader процессы, текст последовательно с без кэширования и по умолчанию соответствует строго к RFC по JSON.Utf8JsonReader processes the text sequentially with no caching and by default adheres strictly to the JSON RFC.

При Utf8JsonReader встречает недопустимый JSON, он выдает <xref:System.Text.Json.JsonReaderException> данными основных ошибок позиции строки номер и байт в строке.When Utf8JsonReader encounters invalid JSON, it throws a <xref:System.Text.Json.JsonReaderException> with basic error information like line number and byte position on the line.

Так как этот тип является ссылочной структурой, он не поддерживает непосредственно async.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.

Чтобы иметь возможность задать Максимальная глубина при чтении или позволяет пропускать комментарии, создайте экземпляр JsonReaderState и передать его в средство чтения.To be able to set max depth while reading OR allow skipping comments, create an instance of JsonReaderState and pass it to the reader.

Конструкторы

Utf8JsonReader(ReadOnlySequence<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySequence<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySequence<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySequence<Byte>, Boolean, JsonReaderState)

Инициализирует новый экземпляр класса Utf8JsonReader.Initializes a new instance of the Utf8JsonReader class.

Utf8JsonReader(ReadOnlySpan<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySpan<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySpan<Byte>, Boolean, JsonReaderState) Utf8JsonReader(ReadOnlySpan<Byte>, Boolean, JsonReaderState)

Инициализирует новый экземпляр класса Utf8JsonReader.Initializes a new instance of the Utf8JsonReader class.

Свойства

BytesConsumed BytesConsumed BytesConsumed BytesConsumed

Возвращает общее число байтов, использованных Utf8JsonReader к настоящему времени для текущего экземпляра Utf8JsonReader с использованием заданного входного текста в кодировке UTF-8.Gets the total number of bytes consumed by the Utf8JsonReader so far for the current instance of the Utf8JsonReader with the given UTF-8 encoded input text.

CurrentDepth CurrentDepth CurrentDepth CurrentDepth

Возвращает глубину текущего токена.Gets the depth of the current token.

CurrentState CurrentState CurrentState CurrentState

Возвращает текущий снимок состояния Utf8JsonReader, которое должно быть записано вызывающим объектом и передано обратно в конструктор Utf8JsonReader с дополнительными данными.Gets the current snapshot of the Utf8JsonReader state that must be captured by the caller and passed back in to the Utf8JsonReader constructor with more data.

HasValueSequence HasValueSequence HasValueSequence HasValueSequence

Возвращает значение, указывающее, какое свойство Value нужно использовать для получения значения токена.Gets a value that indicates which Value property to use to get the token value.

IsFinalBlock IsFinalBlock IsFinalBlock IsFinalBlock
Position Position Position Position

Возвращает текущий SequencePosition в рамках предоставленных входных данных ReadOnlySequence<byte> в кодировке UTF-8 или значение по умолчанию SequencePosition, если структура Utf8JsonReader была создана с использованием ReadOnlySpan<byte>.Gets the current SequencePosition within the provided UTF-8 encoded input ReadOnlySequence<byte> or a default SequencePosition if the Utf8JsonReader struct was constructed with a ReadOnlySpan<byte>.

TokenStartIndex TokenStartIndex TokenStartIndex TokenStartIndex
TokenType TokenType TokenType TokenType

Возвращает тип последнего обработанного токена JSON в тексте JSON с кодировкой UTF-8.Gets the type of the last processed JSON token in the UTF-8 encoded JSON text.

ValueSequence ValueSequence ValueSequence ValueSequence

Возвращает значение последнего обработанного токена в виде среза ReadOnlySpan<byte> входных полезных данных.Gets the value of the last processed token as a ReadOnlySpan<byte> slice of the input payload. Если JSON предоставляется внутри ReadOnlySequence<byte> и срез, представляющий значение токена, умещается в отдельный сегмент, то ValueSpan содержит фрагментированное значение, так как его можно представить в виде диапазона.If the JSON is provided within a ReadOnlySequence<byte> and the slice that represents the token value fits in a single segment, then ValueSpan contains the sliced value since it can be represented as a span. В противном случае ValueSequence содержит значение токена.Otherwise, ValueSequence contains the token value.

ValueSpan ValueSpan ValueSpan ValueSpan

Возвращает значение последнего обработанного токена в виде среза ReadOnlySpan<byte> входных полезных данных.Gets the value of the last processed token as a ReadOnlySpan<byte> slice of the input payload. Если JSON предоставляется внутри ReadOnlySequence<byte> и срез, представляющий значение токена, умещается в отдельный сегмент, то ValueSpan содержит фрагментированное значение, так как его можно представить в виде диапазона.If the JSON is provided within a ReadOnlySequence<byte> and the slice that represents the token value fits in a single segment, then ValueSpan contains the sliced value since it can be represented as a span. В противном случае ValueSequence содержит значение токена.Otherwise, the ValueSequence contains the token value.

Методы

GetBoolean() GetBoolean() GetBoolean() GetBoolean()

Считывает следующее значение токена JSON из источника в виде Boolean.Reads the next JSON token value from the source as a Boolean.

GetBytesFromBase64() GetBytesFromBase64() GetBytesFromBase64() GetBytesFromBase64()
GetComment() GetComment() GetComment() GetComment()
GetDateTime() GetDateTime() GetDateTime() GetDateTime()

Считывает следующее значение токена JSON из источника и преобразует его в DateTime.Reads the next JSON token value from the source and parses it to a DateTime.

GetDateTimeOffset() GetDateTimeOffset() GetDateTimeOffset() GetDateTimeOffset()

Считывает следующее значение токена JSON из источника и преобразует его в DateTimeOffset.Reads the next JSON token value from the source and parses it to a DateTimeOffset.

GetDecimal() GetDecimal() GetDecimal() GetDecimal()

Считывает следующее значение токена JSON из источника и преобразует его в Decimal.Reads the next JSON token value from the source and parses it to a Decimal.

GetDouble() GetDouble() GetDouble() GetDouble()

Считывает следующее значение токена JSON из источника и преобразует его в Double.Reads the next JSON token value from the source and parses it to a Double.

GetGuid() GetGuid() GetGuid() GetGuid()

Считывает следующее значение токена JSON из источника и преобразует его в Guid.Reads the next JSON token value from the source and parses it to a Guid.

GetInt32() GetInt32() GetInt32() GetInt32()

Считывает следующее значение токена JSON из источника и преобразует его в Int32.Reads the next JSON token value from the source and parses it to an Int32.

GetInt64() GetInt64() GetInt64() GetInt64()

Считывает следующее значение токена JSON из источника и преобразует его в Int64.Reads the next JSON token value from the source and parses it to an Int64.

GetSingle() GetSingle() GetSingle() GetSingle()

Считывает следующее значение токена JSON из источника и преобразует его в Single.Reads the next JSON token value from the source and parses it to a Single.

GetString() GetString() GetString() GetString()

Считывает следующее значение токена JSON из источника неэкранированным и перекодированным в String.Reads the next JSON token value from the source, unescaped, and transcoded as a String.

GetUInt32() GetUInt32() GetUInt32() GetUInt32()

Считывает следующее значение токена JSON из источника и преобразует его в UInt32.Reads the next JSON token value from the source and parses it to a UInt32.

GetUInt64() GetUInt64() GetUInt64() GetUInt64()

Считывает следующее значение токена JSON из источника и преобразует его в UInt64.Reads the next JSON token value from the source and parses it to a UInt64.

Read() Read() Read() Read()

Считывает следующий токен JSON из источника входных данных.Read the next JSON token from the input source.

Skip() Skip() Skip() Skip()
TextEquals(ReadOnlySpan<Byte>) TextEquals(ReadOnlySpan<Byte>) TextEquals(ReadOnlySpan<Byte>) TextEquals(ReadOnlySpan<Byte>)

Сравнивает текст в кодировке UTF-8 с неэкранированным значением токена JSON в источнике и возвращает true, если они совпадают.Compares the UTF-8 encoded text to the unescaped JSON token value in the source and returns true if they match.

TextEquals(ReadOnlySpan<Char>) TextEquals(ReadOnlySpan<Char>) TextEquals(ReadOnlySpan<Char>) TextEquals(ReadOnlySpan<Char>)

Сравнивает текст в кодировке UTF-16 с неэкранированным значением токена JSON в источнике и возвращает true, если они совпадают.Compares the UTF-16 encoded text to the unescaped JSON token value in the source and returns true if they match.

TryGetBytesFromBase64(Byte[]) TryGetBytesFromBase64(Byte[]) TryGetBytesFromBase64(Byte[]) TryGetBytesFromBase64(Byte[])
TryGetDateTime(DateTime) TryGetDateTime(DateTime) TryGetDateTime(DateTime) TryGetDateTime(DateTime)

Считывает следующее значение токена JSON из источника и преобразует его в DateTime.Reads the next JSON token value from the source and parses it to a DateTime.

TryGetDateTimeOffset(DateTimeOffset) TryGetDateTimeOffset(DateTimeOffset) TryGetDateTimeOffset(DateTimeOffset) TryGetDateTimeOffset(DateTimeOffset)

Считывает следующее значение токена JSON из источника и преобразует его в DateTimeOffset.Reads the next JSON token value from the source and parses it to a DateTimeOffset.

TryGetDecimal(Decimal) TryGetDecimal(Decimal) TryGetDecimal(Decimal) TryGetDecimal(Decimal)

Считывает следующее значение токена JSON из источника и преобразует его в Decimal.Reads the next JSON token value from the source and parses it to a Decimal.

TryGetDouble(Double) TryGetDouble(Double) TryGetDouble(Double) TryGetDouble(Double)

Считывает следующее значение токена JSON из источника и преобразует его в Double.Reads the next JSON token value from the source and parses it to a Double.

TryGetGuid(Guid) TryGetGuid(Guid) TryGetGuid(Guid) TryGetGuid(Guid)

Считывает следующее значение токена JSON из источника и преобразует его в Guid.Reads the next JSON token value from the source and parses it to a Guid.

TryGetInt32(Int32) TryGetInt32(Int32) TryGetInt32(Int32) TryGetInt32(Int32)

Считывает следующее значение токена JSON из источника и преобразует его в Int32.Reads the next JSON token value from the source and parses it to an Int32.

TryGetInt64(Int64) TryGetInt64(Int64) TryGetInt64(Int64) TryGetInt64(Int64)

Считывает следующее значение токена JSON из источника и преобразует его в Int64.Reads the next JSON token value from the source and parses it to an Int64.

TryGetSingle(Single) TryGetSingle(Single) TryGetSingle(Single) TryGetSingle(Single)

Считывает следующее значение токена JSON из источника и преобразует его в Single.Reads the next JSON token value from the source and parses it to a Single.

TryGetUInt32(UInt32) TryGetUInt32(UInt32) TryGetUInt32(UInt32) TryGetUInt32(UInt32)

Считывает следующее значение токена JSON из источника и преобразует его в UInt32.Reads the next JSON token value from the source and parses it to a UInt32.

TryGetUInt64(UInt64) TryGetUInt64(UInt64) TryGetUInt64(UInt64) TryGetUInt64(UInt64)

Считывает следующее значение токена JSON из источника и преобразует его в UInt64.Reads the next JSON token value from the source and parses it to a UInt64.

TrySkip() TrySkip() TrySkip() TrySkip()

Применяется к