Utf8JsonWriter クラス

  • リファレンス

定義

名前空間:
System.Text.Json
アセンブリ:
System.Text.Json.dll
パッケージ:
System.Text.Json v8.0.5
パッケージ:
System.Text.Json v9.0.0-rc.2.24473.5
ソース:
Utf8JsonWriter.cs
ソース:
Utf8JsonWriter.cs
ソース:
Utf8JsonWriter.cs

UTF-8 でエンコードされた JSON テキストの前方専用のキャッシュされていない書き込み用の高パフォーマンス API を提供します。

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
継承
Object
Utf8JsonWriter
実装
IAsyncDisposable IDisposable

注釈

Utf8JsonWriter は、キャッシュなしでテキストを順番に書き込みます。既定では、コメントの書き込みを除き、JSON RFCに準拠します。

検証が有効になっているときに無効な JSON を書き込もうとするメソッドは、コンテキスト固有のエラー メッセージを含む InvalidOperationException をスローします。

インデントと空白で出力を書式設定したり、検証をスキップしたり、エスケープ動作をカスタマイズしたりできるようにするには、JsonWriterOptions のインスタンスを作成してライターに渡します。

詳細については、「System.Text.Jsonを使用してカスタム シリアライザーとデシリアライザーを記述する方法」を参照してください。

コンストラクター

Utf8JsonWriter(IBufferWriter<Byte>, JsonWriterOptions)

指定した IBufferWriter<T> を使用して、出力の書き込みとカスタマイズ オプションを使用して、Utf8JsonWriter クラスの新しいインスタンスを初期化します。
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>)

生のバイト値を、Base64 でエンコードされた JSON 文字列として JSON 配列の要素として書き込みます。
WriteBoolean(JsonEncodedText, Boolean)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Boolean 値 (json リテラル true または false) を書き込みます。
WriteBoolean(ReadOnlySpan<Byte>, Boolean)

JSON オブジェクトの名前と値のペアの一部として、バイトの読み取り専用スパンとして指定されたプロパティ名と 値 (json リテラル true または false) を書き込みます。
WriteBoolean(ReadOnlySpan<Char>, Boolean)

JSON オブジェクトの名前と値のペアの一部として、読み取り専用の文字スパンと 値として指定されたプロパティ名 (json リテラル true または false) を書き込みます。
WriteBoolean(String, Boolean)

JSON オブジェクトの名前と値のペアの一部として、文字列および 値として指定されたプロパティ名 (json リテラル true または false) を書き込みます。
WriteBooleanValue(Boolean)

json 配列の要素として、 値 (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 オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と JSON リテラル null を書き込みます。
WriteNull(ReadOnlySpan<Byte>)

読み取り専用のバイト スパンとして指定されたプロパティ名を書き込み、JSON リテラルは JSON オブジェクトの名前と値のペアの一部として null します。
WriteNull(ReadOnlySpan<Char>)

読み取り専用の文字スパンとして指定されたプロパティ名を書き込み、JSON リテラル JSON オブジェクトの名前と値のペアの一部として null します。
WriteNull(String)

文字列として指定されたプロパティ名を書き込み、JSON リテラル JSON オブジェクトの名前と値のペアの一部として null します。
WriteNullValue()

JSON 配列の要素として、JSON リテラル null を書き込みます。
WriteNumber(JsonEncodedText, Decimal)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Decimal 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, Double)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Double 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, Int32)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Int32 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, Int64)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Int64 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, Single)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Single 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, UInt32)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と UInt32 値 (JSON 番号) を書き込みます。
WriteNumber(JsonEncodedText, UInt64)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と UInt64 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, Decimal)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Decimal 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, Double)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Double 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, Int32)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前/値ペアの一部として Int32 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, Int64)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前/値ペアの一部として Int64 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, Single)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Single 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, UInt32)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として UInt32 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Byte>, UInt64)

読み取り専用のバイト スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として UInt64 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, Decimal)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Decimal 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, Double)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Double 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, Int32)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Int32 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, Int64)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Int64 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, Single)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として Single 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, UInt32)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として UInt32 値 (JSON 番号) を書き込みます。
WriteNumber(ReadOnlySpan<Char>, UInt64)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として UInt64 値 (JSON 番号) を書き込みます。
WriteNumber(String, Decimal)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Decimal 値 (JSON 番号) を書き込みます。
WriteNumber(String, Double)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Double 値 (JSON 番号) を書き込みます。
WriteNumber(String, Int32)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Int32 値 (JSON 番号) を書き込みます。
WriteNumber(String, Int64)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Int64 値 (JSON 番号) を書き込みます。
WriteNumber(String, Single)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Single 値 (JSON 番号) を書き込みます。
WriteNumber(String, UInt32)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と UInt32 値 (JSON 番号) を書き込みます。
WriteNumber(String, UInt64)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と UInt64 値 (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>)

JSON オブジェクトの名前と値のペアの最初の部分として、UTF-8 プロパティ名を (JSON 文字列として) 書き込みます。
WritePropertyName(ReadOnlySpan<Char>)

プロパティ名 (JSON 文字列) を JSON オブジェクトの名前と値のペアの最初の部分として書き込みます。
WritePropertyName(String)

プロパティ名 (JSON 文字列) を JSON オブジェクトの名前と値のペアの最初の部分として書き込みます。
WriteRawValue(ReadOnlySequence<Byte>, Boolean)

入力を JSON コンテンツとして書き込みます。 入力コンテンツが 1 つの完全な JSON 値であることが予想されます。
WriteRawValue(ReadOnlySpan<Byte>, Boolean)

入力を JSON コンテンツとして書き込みます。 入力コンテンツが 1 つの完全な JSON 値であることが予想されます。
WriteRawValue(ReadOnlySpan<Char>, Boolean)

入力を JSON コンテンツとして書き込みます。 入力コンテンツが 1 つの完全な JSON 値であることが予想されます。
WriteRawValue(String, Boolean)

入力を JSON コンテンツとして書き込みます。 入力コンテンツが 1 つの完全な 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)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と DateTime 値を (JSON 文字列として) 書き込みます。
WriteString(JsonEncodedText, DateTimeOffset)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と DateTimeOffset 値を (JSON 文字列として) 書き込みます。
WriteString(JsonEncodedText, Guid)

JSON オブジェクトの名前と値のペアの一部として、事前にエンコードされたプロパティ名と Guid 値を (JSON 文字列として) 書き込みます。
WriteString(JsonEncodedText, JsonEncodedText)

JSON オブジェクトの名前と値のペアの一部として、事前エンコードされたプロパティ名と事前エンコードされた値 (JSON 文字列として) を書き込みます。
WriteString(JsonEncodedText, ReadOnlySpan<Byte>)

JSON オブジェクトの名前と値のペアの一部として、事前エンコードされたプロパティ名と UTF-8 テキスト値 (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)

JSON オブジェクトの名前と値のペアの一部として、UTF-8 プロパティ名と事前エンコードされた値を (JSON 文字列として) 書き込みます。
WriteString(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)

JSON オブジェクトの名前と値のペアの一部として、UTF-8 プロパティ名と UTF-8 テキスト値 (JSON 文字列) を書き込みます。
WriteString(ReadOnlySpan<Byte>, ReadOnlySpan<Char>)

JSON オブジェクトの名前と値のペアの一部として、UTF-8 プロパティ名と UTF-16 テキスト値 (JSON 文字列として) を書き込みます。
WriteString(ReadOnlySpan<Byte>, String)

JSON オブジェクトの名前と値のペアの一部として、UTF-8 プロパティ名と文字列テキスト値 (JSON 文字列) を書き込みます。
WriteString(ReadOnlySpan<Char>, DateTime)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として (JSON 文字列として) DateTime 値を書き込みます。
WriteString(ReadOnlySpan<Char>, DateTimeOffset)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として (JSON 文字列として) DateTimeOffset 値を書き込みます。
WriteString(ReadOnlySpan<Char>, Guid)

読み取り専用の文字スパンとして指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として (JSON 文字列として) Guid 値を書き込みます。
WriteString(ReadOnlySpan<Char>, JsonEncodedText)

JSON オブジェクトの名前と値のペアの一部として、プロパティ名と事前エンコードされた値を (JSON 文字列として) 書き込みます。
WriteString(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)

JSON オブジェクトの名前と値のペアの一部として、UTF-16 プロパティ名と UTF-8 テキスト値 (JSON 文字列) を書き込みます。
WriteString(ReadOnlySpan<Char>, ReadOnlySpan<Char>)

JSON オブジェクトの名前と値のペアの一部として、UTF-16 プロパティ名と UTF-16 テキスト値 (JSON 文字列) を書き込みます。
WriteString(ReadOnlySpan<Char>, String)

JSON オブジェクトの名前と値のペアの一部として、UTF-16 プロパティ名と文字列テキスト値 (JSON 文字列) を書き込みます。
WriteString(String, DateTime)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と DateTime 値 (JSON 文字列として) を書き込みます。
WriteString(String, DateTimeOffset)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と DateTimeOffset 値 (JSON 文字列として) を書き込みます。
WriteString(String, Guid)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と Guid 値 (JSON 文字列として) を書き込みます。
WriteString(String, JsonEncodedText)

JSON オブジェクトの名前と値のペアの一部として、プロパティ名と事前エンコードされた値を (JSON 文字列として) 書き込みます。
WriteString(String, ReadOnlySpan<Byte>)

文字列として指定されたプロパティ名と、JSON オブジェクトの名前と値のペアの一部として UTF-8 テキスト値 (JSON 文字列として) を書き込みます。
WriteString(String, ReadOnlySpan<Char>)

JSON オブジェクトの名前と値のペアの一部として、文字列として指定されたプロパティ名と (JSON 文字列として) UTF-16 テキスト値を書き込みます。
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>)

(JSON 文字列として) UTF-8 テキスト値を JSON 配列の要素として書き込みます。
WriteStringValue(ReadOnlySpan<Char>)

UTF-16 テキスト値 (JSON 文字列) を JSON 配列の要素として書き込みます。
WriteStringValue(String)

文字列テキスト値 (JSON 文字列) を JSON 配列の要素として書き込みます。

拡張メソッド

ConfigureAwait(IAsyncDisposable, Boolean)

非同期破棄から返されるタスクの待機を実行する方法を構成します。

適用対象