Utf8JsonWriter Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет высокопроизводительный API для однонаправленной некэшированной записи текста JSON в кодировке UTF-8.
public ref class Utf8JsonWriter sealed : IAsyncDisposable, IDisposable
public sealed class Utf8JsonWriter : IAsyncDisposable, IDisposable
type Utf8JsonWriter = class
interface IAsyncDisposable
interface IDisposable
type Utf8JsonWriter = class
interface IDisposable
interface IAsyncDisposable
Public NotInheritable Class Utf8JsonWriter
Implements IAsyncDisposable, IDisposable
- Наследование
-
Utf8JsonWriter
- Реализации
Комментарии
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, который еще не был записан, и освобождает все ресурсы, используемые текущим экземпляром. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
Flush() |
Фиксирует текст JSON, записанный на данный момент, что делает его доступным для места назначения вывода. |
FlushAsync(CancellationToken) |
Асинхронно фиксирует текст JSON, записанный на данный момент, что делает его доступным для места назначения вывода. |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
Reset() |
Восстанавливает внутреннее состояние этого экземпляра, чтобы его можно было использовать повторно. |
Reset(IBufferWriter<Byte>) |
Восстанавливает внутреннее состояние этого экземпляра, чтобы его можно было использовать повторно с новым экземпляром IBufferWriter<T>. |
Reset(Stream) |
Восстанавливает внутреннее состояние этого экземпляра, чтобы его можно было использовать повторно с новым экземпляром Stream. |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
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. |
WriteBase64StringValue(ReadOnlySpan<Byte>) |
Записывает необработанные байты (в виде строки JSON в кодировке Base64) в качестве элемента массива JSON. |
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) в качестве элемента массива JSON. |
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 в качестве элемента массива JSON. |
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) как элемент массива JSON. |
WriteNumberValue(Double) |
Записывает значение Double (в виде числа JSON) как элемент массива JSON. |
WriteNumberValue(Int32) |
Записывает значение Int32 (в виде числа JSON) как элемент массива JSON. |
WriteNumberValue(Int64) |
Записывает значение Int64 (в виде числа JSON) как элемент массива JSON. |
WriteNumberValue(Single) |
Записывает значение Single (в виде числа JSON) как элемент массива JSON. |
WriteNumberValue(UInt32) |
Записывает значение UInt32 (в виде числа JSON) как элемент массива JSON. |
WriteNumberValue(UInt64) |
Записывает значение UInt64 (в виде числа JSON) как элемент массива 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) в качестве элемента массива JSON. |
WriteStringValue(DateTimeOffset) |
Записывает значение DateTimeOffset (в виде строки JSON) в качестве элемента массива JSON. |
WriteStringValue(Guid) |
Записывает значение Guid (в виде строки JSON) в качестве элемента массива JSON. |
WriteStringValue(JsonEncodedText) |
Записывает заранее закодированное значение (в виде строки JSON) в качестве элемента массива JSON. |
WriteStringValue(ReadOnlySpan<Byte>) |
Записывает текстовое значение UTF-8 (в виде строки JSON) в качестве элемента массива JSON. |
WriteStringValue(ReadOnlySpan<Char>) |
Записывает текстовое значение UTF-16 (в виде строки JSON) в качестве элемента массива JSON. |
WriteStringValue(String) |
Записывает строковое текстовое значение (в виде строки JSON) в качестве элемента массива JSON. |
Методы расширения
ConfigureAwait(IAsyncDisposable, Boolean) |
Настраивает способ выполнения ожиданий для задач, возвращаемых из асинхронного высвобождаемого объекта. |
Применяется к
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по