JsonSerializer.Serialize メソッド

定義

名前空間:

System.Text.Json

アセンブリ:

System.Text.Json.dll

オーバーロード

Serialize(Stream, Object, Type, JsonSerializerContext)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)	指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)	指定された型の JSON 表現を指定されたライターに書き込みます。
Serialize(Utf8JsonWriter, Object, JsonTypeInfo)	指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。
Serialize(Stream, Object, Type, JsonSerializerOptions)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
Serialize(Object, Type, JsonSerializerOptions)	指定した型の値を JSON 文字列に変換します。
Serialize(Stream, Object, JsonTypeInfo)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
Serialize(Object, JsonTypeInfo)	指定した値を Stringに変換します。
Serialize(Object, Type, JsonSerializerContext)	指定した値を Stringに変換します。
Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)	ジェネリック型パラメーターで指定された型の JSON 表現を、指定されたライターに書き込みます。
Serialize<TValue>(TValue, JsonSerializerOptions)	ジェネリック型パラメーターで指定された型の値を JSON 文字列に変換します。
Serialize<TValue>(TValue, JsonTypeInfo<TValue>)	指定した値を Stringに変換します。
Serialize<TValue>(Stream, TValue, JsonSerializerOptions)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)	指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。

Serialize(Stream, Object, Type, JsonSerializerContext)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

public:
 static void Serialize(System::IO::Stream ^ utf8Json, System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static void Serialize (System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : System.IO.Stream * obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, inputType As Type, context As JsonSerializerContext)

パラメーター

utf8Json

Stream

書き込む UTF-8 Stream。

value

Object

変換する値。

inputType

Type

変換する value の型。

context

JsonSerializerContext

シリアル化可能な型のメタデータ プロバイダー。

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json、inputType、または context が null。

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

ソース:

JsonSerializer.Write.Utf8JsonWriter.cs

指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。

public:
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : System.Text.Json.Utf8JsonWriter * obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> unit

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, context As JsonSerializerContext)

パラメーター

writer

Utf8JsonWriter

書き込む JSON ライター。

value

Object

変換および書き込む値。

inputType

Type

変換する value の型。

context

JsonSerializerContext

シリアル化可能な型のメタデータ プロバイダー。

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

writer または inputType が null。

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

InvalidOperationException

指定された context の GetTypeInfo(Type) メソッドは、変換する型の null を返します。

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

ソース:

JsonSerializer.Write.Utf8JsonWriter.cs

指定された型の JSON 表現を指定されたライターに書き込みます。

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.Text.Json.Utf8JsonWriter * obj * Type * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing)

パラメーター

writer

Utf8JsonWriter

書き込む JSON ライター。

value

Object

変換および書き込む値。

inputType

Type

変換する value の型。

options

JsonSerializerOptions

シリアル化の動作を制御するオプション。

例外

ArgumentException

inputType は value と互換性がありません

ArgumentNullException

writer または inputType が null。

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

注釈

Utf8JsonWriter のインスタンスの作成に使用される JsonWriterOptions は、競合時に JsonSerializerOptions よりも優先されます。 そのため、JsonWriterOptions.Indented、JsonWriterOptions.SkipValidation、および JsonWriterOptions.Encoder は、書き込み中に使用されます。

詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

ソース:

JsonSerializer.Write.Utf8JsonWriter.cs

指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。

public:
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : System.Text.Json.Utf8JsonWriter * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> unit

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, jsonTypeInfo As JsonTypeInfo)

パラメーター

writer

Utf8JsonWriter

書き込むライター。

value

Object

変換および書き込む値。

jsonTypeInfo

JsonTypeInfo

変換する型に関するメタデータ。

例外

ArgumentNullException

writer または jsonTypeInfo が null。

InvalidCastException

value は jsonTypeInfoの種類と一致しません。

Serialize(Stream, Object, Type, JsonSerializerOptions)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

public static void Serialize (System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing)

パラメーター

utf8Json

Stream

書き込む UTF-8 Stream。

value

Object

変換する値。

inputType

Type

変換する value の型。

options

JsonSerializerOptions

変換動作を制御するオプション。

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json または inputType が null。

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

Serialize(Object, Type, JsonSerializerOptions)

ソース:

JsonSerializer.Write.String.cs

指定した型の値を JSON 文字列に変換します。

public static string Serialize (object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : obj * Type * System.Text.Json.JsonSerializerOptions -> string

Public Function Serialize (value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing) As String

パラメーター

value

Object

変換する値。

inputType

Type

変換する value の型。

options

JsonSerializerOptions

変換動作を制御するオプション。

戻り値

String

値の JSON 文字列表現。

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

inputType は nullです。

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

注釈

実装では内部的に UTF-8 を使用するため、String の使用は UTF-8 エンコードの使用ほど効率的ではありません。 SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) と SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)も参照してください。

詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。

Serialize(Stream, Object, JsonTypeInfo)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

public:
 static void Serialize(System::IO::Stream ^ utf8Json, System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static void Serialize (System.IO.Stream utf8Json, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : System.IO.Stream * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo)

パラメーター

utf8Json

Stream

書き込む UTF-8 Stream。

value

Object

変換する値。

jsonTypeInfo

JsonTypeInfo

変換する型に関するメタデータ。

例外

ArgumentNullException

utf8Json は nullです。

InvalidCastException

value は jsonTypeInfoの種類と一致しません。

Serialize(Object, JsonTypeInfo)

ソース:

JsonSerializer.Write.String.cs

指定した値を Stringに変換します。

public:
 static System::String ^ Serialize(System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static string Serialize (object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> string

Public Function Serialize (value As Object, jsonTypeInfo As JsonTypeInfo) As String

パラメーター

value

Object

変換する値。

jsonTypeInfo

JsonTypeInfo

変換する型に関するメタデータ。

戻り値

String

値の String 表現。

例外

ArgumentNullException

jsonTypeInfo は nullです。

InvalidCastException

value は jsonTypeInfoの種類と一致しません。

注釈

実装では内部的に UTF-8 を使用するため、String の使用は UTF-8 エンコードの使用ほど効率的ではありません。 SerializeToUtf8Bytes(Object, JsonTypeInfo) と SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)も参照してください。

Serialize(Object, Type, JsonSerializerContext)

ソース:

JsonSerializer.Write.String.cs

指定した値を Stringに変換します。

public:
 static System::String ^ Serialize(System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static string Serialize (object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> string

Public Function Serialize (value As Object, inputType As Type, context As JsonSerializerContext) As String

パラメーター

value

Object

変換する値。

inputType

Type

変換する value の型。

context

JsonSerializerContext

シリアル化可能な型のメタデータ プロバイダー。

戻り値

String

値の String 表現。

例外

NotSupportedException

inputType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

InvalidOperationException

指定された context の GetTypeInfo(Type) メソッドは、変換する型の null を返します。

ArgumentNullException

inputType または context が null。

注釈

実装では内部的に UTF-8 を使用するため、String の使用は UTF-8 エンコードの使用ほど効率的ではありません。 SerializeToUtf8Bytes(Object, Type, JsonSerializerContext) と SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)も参照してください。

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

ソース:

JsonSerializer.Write.Utf8JsonWriter.cs

ジェネリック型パラメーターで指定された型の JSON 表現を、指定されたライターに書き込みます。

public static void Serialize<TValue> (System.Text.Json.Utf8JsonWriter writer, TValue value, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.Text.Json.Utf8JsonWriter * 'Value * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize(Of TValue) (writer As Utf8JsonWriter, value As TValue, Optional options As JsonSerializerOptions = Nothing)

型パラメーター

TValue

シリアル化する値の型。

パラメーター

writer

Utf8JsonWriter

書き込む JSON ライター。

value

TValue

変換および書き込む値。

options

JsonSerializerOptions

シリアル化の動作を制御するオプション。

例外

ArgumentNullException

writer は nullです。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

注釈

Utf8JsonWriter のインスタンスの作成に使用される JsonWriterOptions は、競合時に JsonSerializerOptions よりも優先されます。 そのため、JsonWriterOptions.Indented、JsonWriterOptions.SkipValidation、および JsonWriterOptions.Encoder は、書き込み中に使用されます。

詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。

Serialize<TValue>(TValue, JsonSerializerOptions)

ソース:

JsonSerializer.Write.String.cs

ジェネリック型パラメーターで指定された型の値を JSON 文字列に変換します。

public static string Serialize<TValue> (TValue value, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : 'Value * System.Text.Json.JsonSerializerOptions -> string

Public Function Serialize(Of TValue) (value As TValue, Optional options As JsonSerializerOptions = Nothing) As String

型パラメーター

TValue

シリアル化する値の型。

パラメーター

value

TValue

変換する値。

options

JsonSerializerOptions

シリアル化の動作を制御するオプション。

戻り値

String

値の JSON 文字列表現。

例外

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

注釈

実装では内部的に UTF-8 を使用するため、String の使用は UTF-8 エンコードの使用ほど効率的ではありません。 SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) と SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)も参照してください。

詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。

Serialize<TValue>(TValue, JsonTypeInfo<TValue>)

ソース:

JsonSerializer.Write.String.cs

指定した値を Stringに変換します。

public:
generic <typename TValue>
 static System::String ^ Serialize(TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static string Serialize<TValue> (TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> string

Public Function Serialize(Of TValue) (value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue)) As String

型パラメーター

TValue

シリアル化する値の型。

パラメーター

value

TValue

変換する値。

jsonTypeInfo

JsonTypeInfo<TValue>

変換する型に関するメタデータ。

戻り値

String

値の String 表現。

例外

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

ArgumentNullException

jsonTypeInfo は nullです。

注釈

実装では内部的に UTF-8 を使用するため、String の使用は UTF-8 エンコードの使用ほど効率的ではありません。 SerializeToUtf8Bytes<TValue>(TValue, JsonTypeInfo<TValue>) と SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)も参照してください。

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

public static void Serialize<TValue> (System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing)

型パラメーター

TValue

シリアル化する値の型。

パラメーター

utf8Json

Stream

書き込む UTF-8 Stream。

value

TValue

変換する値。

options

JsonSerializerOptions

変換動作を制御するオプション。

例外

ArgumentNullException

utf8Json は nullです。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

public:
generic <typename TValue>
 static void Serialize(System::IO::Stream ^ utf8Json, TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static void Serialize<TValue> (System.IO.Stream utf8Json, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : System.IO.Stream * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> unit

Public Sub Serialize(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue))

型パラメーター

TValue

シリアル化する値の型。

パラメーター

utf8Json

Stream

書き込む UTF-8 Stream。

value

TValue

変換する値。

jsonTypeInfo

JsonTypeInfo<TValue>

変換する型に関するメタデータ。

例外

ArgumentNullException

utf8Json は nullです。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。

Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)

ソース:

JsonSerializer.Write.Utf8JsonWriter.cs

指定されたライターに 1 つの JSON 値 (オブジェクトまたは配列を含む) を書き込みます。

public:
generic <typename TValue>
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static void Serialize<TValue> (System.Text.Json.Utf8JsonWriter writer, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : System.Text.Json.Utf8JsonWriter * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> unit

Public Sub Serialize(Of TValue) (writer As Utf8JsonWriter, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue))

型パラメーター

TValue

シリアル化する値の型。

パラメーター

writer

Utf8JsonWriter

書き込むライター。

value

TValue

変換および書き込む値。

jsonTypeInfo

JsonTypeInfo<TValue>

変換する型に関するメタデータ。

例外

ArgumentNullException

writer または jsonTypeInfo が null。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。