Utf8JsonWriter Класс

Определение

Пространство имен:

System.Text.Json

Сборка:

System.Text.Json.dll

Пакет:

System.Text.Json v11.0.0-preview.4.26230.115

Исходный код:

Utf8JsonWriter.cs

Предоставляет высокопроизводительный API для только пересылки, не кэшированной записи текста JSON в кодировке UTF-8.

public ref class Utf8JsonWriter sealed : IAsyncDisposable, IDisposable

public sealed class Utf8JsonWriter : IAsyncDisposable, IDisposable

type Utf8JsonWriter = class
    interface IDisposable
    interface IAsyncDisposable

Public NotInheritable Class Utf8JsonWriter
Implements IAsyncDisposable, IDisposable

Наследование

Object

Utf8JsonWriter

Реализации

IAsyncDisposable IDisposable

Комментарии

Utf8JsonWriter записывает текст последовательно без кэширования и по умолчанию соответствует JSON RFC, за исключением написания комментариев.

Метод, который пытается написать недопустимый КОД JSON, если проверка включена, вызывает InvalidOperationException сообщение об ошибке, зависящее от контекста.

Чтобы отформатировать выходные данные с отступами и пробелами, пропустить проверку или настроить поведение экранирования, создайте экземпляр JsonWriterOptions и передайте его в модуль записи.

Дополнительные сведения см. в статье "Создание пользовательских сериализаторов и десериализаторов" с помощью System.Text.Json.

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

Имя	Описание
Utf8JsonWriter(IBufferWriter<Byte>, JsonWriterOptions)	Инициализирует новый экземпляр Utf8JsonWriter класса, используя указанный IBufferWriter<T> для записи выходных данных в параметры настройки и вывода.
Utf8JsonWriter(Stream, JsonWriterOptions)	Инициализирует новый экземпляр класса с помощью указанного Utf8JsonWriter потока для записи выходных данных в параметры настройки и вывода.

Свойства

Имя	Описание
BytesCommitted	Возвращает общее количество байтов, зафиксированных в выходных данных текущего экземпляра до сих пор.
BytesPending	Возвращает количество байтов, записанных Utf8JsonWriter до сих пор, которые еще не были удалены в выходные данные и зафиксированы.
CurrentDepth	Возвращает глубину текущего маркера.
Options	Возвращает настраиваемое поведение при написании JSON с помощью этого экземпляра, указывающее, следует ли форматировать выходные данные во время записи, пропускать структурную проверку JSON и какие символы следует экранировать.

Методы

Имя	Описание
Dispose()	Фиксирует любой оставшийся текст JSON, который еще не удален и освобождает все ресурсы, используемые текущим экземпляром.
DisposeAsync()	Асинхронно фиксирует любой оставшийся текст JSON, который еще не удален и освобождает все ресурсы, используемые текущим экземпляром.
Flush()	Фиксирует текст JSON, написанный до сих пор, что делает его видимым для назначения выходных данных.
FlushAsync(CancellationToken)	Асинхронно фиксирует текст JSON, написанный до сих пор, что делает его видимым для назначения выходных данных.
Reset()	Сбрасывает внутреннее состояние этого экземпляра, чтобы его можно было повторно использовать.
Reset(IBufferWriter<Byte>, JsonWriterOptions)	Предоставляет высокопроизводительный API для только пересылки, не кэшированной записи текста JSON в кодировке UTF-8.
Reset(IBufferWriter<Byte>)	Сбрасывает внутреннее состояние этого экземпляра, чтобы его можно было повторно использовать с новым экземпляром IBufferWriter<T>.
Reset(Stream, JsonWriterOptions)	Предоставляет высокопроизводительный API для только пересылки, не кэшированной записи текста JSON в кодировке UTF-8.
Reset(Stream)	Сбрасывает внутреннее состояние этого экземпляра, чтобы его можно было повторно использовать с новым экземпляром Stream.
WriteBase64String(JsonEncodedText, ReadOnlySpan<Byte>)	Записывает предварительно закодированное имя свойства и значение необработанных байтов (в виде строки JSON в кодировке Base64) в составе пары имен и значений объекта JSON.
WriteBase64String(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Записывает имя свойства и значение необработанных байтов (в виде строки JSON в кодировке Base64) в составе пары "имя-значение" объекта JSON.
WriteBase64String(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	Записывает имя свойства и значение необработанных байтов (в виде строки JSON в кодировке Base64) в составе пары "имя-значение" объекта JSON.
WriteBase64String(String, ReadOnlySpan<Byte>)	Записывает имя свойства и значение необработанных байтов (в виде строки JSON в кодировке Base64) в составе пары "имя-значение" объекта JSON.
WriteBase64StringSegment(ReadOnlySpan<Byte>, Boolean)	Записывает входные байты в виде частичной строки JSON.
WriteBase64StringValue(ReadOnlySpan<Byte>)	Записывает необработанное значение байтов в виде строки JSON в кодировке Base64.
WriteBoolean(JsonEncodedText, Boolean)	Записывает предварительно закодированное имя и Boolean значение свойства (в виде литерала JSON true или false) в составе пары имен и значений объекта JSON.
WriteBoolean(ReadOnlySpan<Byte>, Boolean)	Записывает имя свойства, указанное как диапазон байтов, доступных только для чтения, и Boolean значение (как литерал JSON true или false) в составе пары "имя-значение" объекта JSON.
WriteBoolean(ReadOnlySpan<Char>, Boolean)	Записывает имя свойства, указанное как диапазон символов только для чтения, и Boolean значение (как литерал JSON true или false) в составе пары имен и значений объекта JSON.
WriteBoolean(String, Boolean)	Записывает имя свойства, указанное в виде строки и Boolean значения (в виде литерала JSON true или false) в составе пары "имя-значение" объекта JSON.
WriteBooleanValue(Boolean)	Записывает Boolean значение (как литерал JSON true или false).
WriteCommentValue(ReadOnlySpan<Byte>)	Записывает текстовое значение UTF-8 в виде комментария JSON.
WriteCommentValue(ReadOnlySpan<Char>)	Записывает текстовое значение UTF-16 в виде комментария JSON.
WriteCommentValue(String)	Записывает строковое текстовое значение в виде комментария JSON.
WriteEndArray()	Записывает конец массива JSON.
WriteEndObject()	Записывает конец объекта JSON.
WriteNull(JsonEncodedText)	Записывает предварительно закодированное имя свойства и литерал JSON null в составе пары "имя-значение" объекта JSON.
WriteNull(ReadOnlySpan<Byte>)	Записывает имя свойства, указанное как диапазон байтов, доступных только для чтения, и литерал JSON null в составе пары "имя-значение" объекта JSON.
WriteNull(ReadOnlySpan<Char>)	Записывает имя свойства, указанное как диапазон символов только для чтения, и литерал JSON null в составе пары "имя-значение" объекта JSON.
WriteNull(String)	Записывает имя свойства, указанное в виде строки, и литерал JSON null в составе пары "имя-значение" объекта JSON.
WriteNullValue()	Записывает литерал JSON NULL.
WriteNumber(JsonEncodedText, Decimal)	Записывает предварительно закодированное имя и Decimal значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, Double)	Записывает предварительно закодированное имя и Double значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, Int32)	Записывает предварительно закодированное имя и Int32 значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, Int64)	Записывает предварительно закодированное имя и Int64 значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, Single)	Записывает предварительно закодированное имя и Single значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, UInt32)	Записывает предварительно закодированное имя и UInt32 значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(JsonEncodedText, UInt64)	Записывает предварительно закодированное имя и UInt64 значение свойства (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, Decimal)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и Decimal значения (в виде числа JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, Double)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и Double значения (в виде числа JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, Int32)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и Int32 значения (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, Int64)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и Int64 значения (как номер JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, Single)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и Single значения (в виде числа JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, UInt32)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и UInt32 значения (в виде числа JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Byte>, UInt64)	Записывает имя свойства, указанное в виде диапазона только для чтения байтов и UInt64 значения (в виде числа JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, Decimal)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и Decimal значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, Double)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и Double значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, Int32)	Записывает имя свойства, указанное как диапазон символов только для чтения, и Int32 значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, Int64)	Записывает имя свойства, указанное как диапазон символов только для чтения, и Int64 значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, Single)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и Single значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, UInt32)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и UInt32 значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(ReadOnlySpan<Char>, UInt64)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и UInt64 значение (как номер JSON) в составе пары имен и значений объекта JSON.
WriteNumber(String, Decimal)	Записывает имя свойства, указанное в виде строки и Decimal значения (в виде числа JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(String, Double)	Записывает имя свойства, указанное в виде строки и Double значения (в виде числа JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(String, Int32)	Записывает имя свойства, указанное в виде строки и Int32 значения (в виде номера JSON) в рамках пары "имя-значение" объекта JSON.
WriteNumber(String, Int64)	Записывает имя свойства, указанное в виде строки и Int64 значения (в виде номера JSON) в рамках пары "имя-значение" объекта JSON.
WriteNumber(String, Single)	Записывает имя свойства, указанное в виде строки и Single значения (в виде числа JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(String, UInt32)	Записывает имя свойства, указанное в виде строки и UInt32 значения (в виде числа JSON) в составе пары "имя-значение" объекта JSON.
WriteNumber(String, UInt64)	Записывает имя свойства, указанное в виде строки и UInt64 значения (в виде числа JSON) в составе пары "имя-значение" объекта JSON.
WriteNumberValue(Decimal)	Записывает Decimal значение (как номер JSON).
WriteNumberValue(Double)	Записывает Double значение (как номер JSON).
WriteNumberValue(Int32)	Записывает Int32 значение (как номер JSON).
WriteNumberValue(Int64)	Записывает Int64 значение (как номер JSON).
WriteNumberValue(Single)	Записывает Single значение (как номер JSON).
WriteNumberValue(UInt32)	Записывает UInt32 значение (как номер JSON).
WriteNumberValue(UInt64)	Записывает UInt64 значение (как номер JSON).
WritePropertyName(JsonEncodedText)	Записывает предварительно закодированное имя свойства (в виде строки JSON) в качестве первой части пары имен и значений объекта JSON.
WritePropertyName(ReadOnlySpan<Byte>)	Записывает имя свойства UTF-8 (в виде строки JSON) в качестве первой части пары имен и значений объекта JSON.
WritePropertyName(ReadOnlySpan<Char>)	Записывает имя свойства (в виде строки JSON) в качестве первой части пары "имя-значение" объекта JSON.
WritePropertyName(String)	Записывает имя свойства (в виде строки JSON) в качестве первой части пары "имя-значение" объекта JSON.
WriteRawValue(ReadOnlySequence<Byte>, Boolean)	Записывает входные данные в виде содержимого JSON. Ожидается, что входное содержимое является одним полным значением JSON.
WriteRawValue(ReadOnlySpan<Byte>, Boolean)	Записывает входные данные в виде содержимого JSON. Ожидается, что входное содержимое является одним полным значением JSON.
WriteRawValue(ReadOnlySpan<Char>, Boolean)	Записывает входные данные в виде содержимого JSON. Ожидается, что входное содержимое является одним полным значением JSON.
WriteRawValue(String, Boolean)	Записывает входные данные в виде содержимого JSON. Ожидается, что входное содержимое является одним полным значением JSON.
WriteStartArray()	Записывает начало массива JSON.
WriteStartArray(JsonEncodedText)	Записывает начало массива JSON с предварительно закодированным именем свойства в качестве ключа.
WriteStartArray(ReadOnlySpan<Byte>)	Записывает начало массива JSON с именем свойства, указанным как диапазон только для чтения байтов в качестве ключа.
WriteStartArray(ReadOnlySpan<Char>)	Записывает начало массива JSON с именем свойства, указанным как диапазон символов только для чтения в качестве ключа.
WriteStartArray(String)	Записывает начало массива JSON с именем свойства, указанным в виде строки в качестве ключа.
WriteStartObject()	Записывает начало объекта JSON.
WriteStartObject(JsonEncodedText)	Записывает начало объекта JSON с предварительно закодированным именем свойства в качестве ключа.
WriteStartObject(ReadOnlySpan<Byte>)	Записывает начало объекта JSON с именем свойства, указанным как диапазон байтов только для чтения в качестве ключа.
WriteStartObject(ReadOnlySpan<Char>)	Записывает начало объекта JSON с именем свойства, указанным как диапазон символов только для чтения в качестве ключа.
WriteStartObject(String)	Записывает начало объекта JSON с именем свойства, указанным в виде строки в качестве ключа.
WriteString(JsonEncodedText, DateTime)	Записывает предварительно закодированное имя и DateTime значение свойства (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(JsonEncodedText, DateTimeOffset)	Записывает предварительно закодированное имя и DateTimeOffset значение свойства (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(JsonEncodedText, Guid)	Записывает предварительно закодированное имя и Guid значение свойства (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(JsonEncodedText, JsonEncodedText)	Записывает предварительно закодированное имя свойства и предварительно закодированное значение (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(JsonEncodedText, ReadOnlySpan<Byte>)	Записывает предварительно закодированное имя свойства и текстовое значение UTF-8 (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(JsonEncodedText, ReadOnlySpan<Char>)	Записывает предварительно закодированное имя свойства и текстовое значение (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(JsonEncodedText, String)	Записывает предварительно закодированное имя свойства и строковое текстовое значение (в виде строки JSON) в составе пары "имя-значение" объекта JSON.
WriteString(ReadOnlySpan<Byte>, DateTime)	Записывает имя свойства UTF-8 и DateTime значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Byte>, DateTimeOffset)	Записывает имя свойства UTF-8 и DateTimeOffset значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Byte>, Guid)	Записывает имя свойства UTF-8 и Guid значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Byte>, JsonEncodedText)	Записывает имя свойства UTF-8 и предварительно закодированное значение (в виде строки JSON) в составе пары "имя-значение" объекта JSON.
WriteString(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Записывает имя свойства UTF-8 и текстовое значение UTF-8 (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Byte>, ReadOnlySpan<Char>)	Записывает имя свойства UTF-8 и текстовое значение UTF-16 (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Byte>, String)	Записывает имя свойства UTF-8 и строковое текстовое значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, DateTime)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и DateTime значение (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, DateTimeOffset)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и DateTimeOffset значение (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, Guid)	Записывает имя свойства, указанное как диапазон символов, доступный только для чтения, и Guid значение (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, JsonEncodedText)	Записывает имя свойства и предварительно закодированное значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	Записывает имя свойства UTF-16 и текстовое значение UTF-8 (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, ReadOnlySpan<Char>)	Записывает имя свойства UTF-16 и текстовое значение UTF-16 (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(ReadOnlySpan<Char>, String)	Записывает имя свойства UTF-16 и строковое текстовое значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(String, DateTime)	Записывает имя свойства, указанное в виде строки и DateTime значения (в виде строки JSON) в рамках пары "имя-значение" объекта JSON.
WriteString(String, DateTimeOffset)	Записывает имя свойства, указанное в виде строки и DateTimeOffset значения (в виде строки JSON) в рамках пары "имя-значение" объекта JSON.
WriteString(String, Guid)	Записывает имя свойства, указанное в виде строки и Guid значения (в виде строки JSON) в рамках пары "имя-значение" объекта JSON.
WriteString(String, JsonEncodedText)	Записывает имя свойства и предварительно закодированное значение (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(String, ReadOnlySpan<Byte>)	Записывает имя свойства, указанное в виде строки, и текстовое значение UTF-8 (в виде строки JSON) в составе пары имен и значений объекта JSON.
WriteString(String, ReadOnlySpan<Char>)	Записывает имя свойства, указанное в виде строки, и текстовое значение UTF-16 (в виде строки JSON) в рамках пары имен и значений объекта JSON.
WriteString(String, String)	Записывает имя свойства, указанное в виде строки, и строковое текстовое значение (в виде строки JSON) в рамках пары "имя-значение" объекта JSON.
WriteStringValue(DateTime)	Записывает DateTime значение (в виде строки JSON).
WriteStringValue(DateTimeOffset)	Записывает DateTimeOffset значение (в виде строки JSON).
WriteStringValue(Guid)	Записывает Guid значение (в виде строки JSON).
WriteStringValue(JsonEncodedText)	Записывает предварительно закодированное текстовое значение (в виде строки JSON).
WriteStringValue(ReadOnlySpan<Byte>)	Записывает текстовое значение UTF-8 (как строку JSON).
WriteStringValue(ReadOnlySpan<Char>)	Записывает текстовое значение UTF-16 (как строку JSON).
WriteStringValue(String)	Записывает строковое текстовое значение (как строку JSON).
WriteStringValueSegment(ReadOnlySpan<Byte>, Boolean)	Записывает сегмент текстового значения UTF-8 в виде частичной строки JSON.
WriteStringValueSegment(ReadOnlySpan<Char>, Boolean)	Записывает сегмент текстового значения в виде частичной строки JSON.