JsonSerializer.Serialize Método

Definición

Espacio de nombres:

System.Text.Json

Ensamblado:

System.Text.Json.dll

Sobrecargas

Serialize(Stream, Object, Type, JsonSerializerContext)	Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)	Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)	Escribe la representación JSON del tipo especificado en el escritor proporcionado.
Serialize(Utf8JsonWriter, Object, JsonTypeInfo)	Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.
Serialize(Stream, Object, Type, JsonSerializerOptions)	Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream.
Serialize(Object, Type, JsonSerializerOptions)	Convierte el valor de un tipo especificado en una cadena JSON.
Serialize(Stream, Object, JsonTypeInfo)	Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream.
Serialize(Object, JsonTypeInfo)	Convierte el valor proporcionado en un String.
Serialize(Object, Type, JsonSerializerContext)	Convierte el valor proporcionado en un String.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)	Escribe la representación JSON de un tipo especificado por un parámetro de tipo genérico en el escritor proporcionado.
Serialize<TValue>(TValue, JsonSerializerOptions)	Convierte el valor de un tipo especificado por un parámetro de tipo genérico en una cadena JSON.
Serialize<TValue>(TValue, JsonTypeInfo<TValue>)	Convierte el valor proporcionado en un String.
Serialize<TValue>(Stream, TValue, JsonSerializerOptions)	Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream.
Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)	Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)	Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.

Serialize(Stream, Object, Type, JsonSerializerContext)

Source:

JsonSerializer.Write.Stream.cs

Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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)

Parámetros

utf8Json

Stream

El UTF-8 Stream en el que se va a escribir.

value

Object

Valor que se va a convertir.

inputType

Type

Tipo del value que se va a convertir.

context

JsonSerializerContext

Proveedor de metadatos para tipos serializables.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json, inputTypeo context es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Source:

JsonSerializer.Write.Utf8JsonWriter.cs

Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.

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)

Parámetros

writer

Utf8JsonWriter

Escritor JSON en el que se va a escribir.

value

Object

Valor que se va a convertir y escribir.

inputType

Type

Tipo del value que se va a convertir.

context

JsonSerializerContext

Proveedor de metadatos para tipos serializables.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

writer o inputType es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

InvalidOperationException

El método GetTypeInfo(Type) del context proporcionado devuelve null para que el tipo se convierta.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Source:

JsonSerializer.Write.Utf8JsonWriter.cs

Escribe la representación JSON del tipo especificado en el escritor proporcionado.

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)

Parámetros

writer

Utf8JsonWriter

Escritor JSON en el que se va a escribir.

value

Object

Valor que se va a convertir y escribir.

inputType

Type

Tipo del value que se va a convertir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de serialización.

Excepciones

ArgumentException

inputType no es compatible con value

ArgumentNullException

writer o inputType es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

Comentarios

El JsonWriterOptions usado para crear la instancia del Utf8JsonWriter tiene prioridad sobre el JsonSerializerOptions cuando entran en conflicto. Por lo tanto, se usan JsonWriterOptions.Indented, JsonWriterOptions.SkipValidationy JsonWriterOptions.Encoder al escribir.

Para obtener más información, consulte Cómo serializar y deserializar JSON.

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Source:

JsonSerializer.Write.Utf8JsonWriter.cs

Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.

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)

Parámetros

writer

Utf8JsonWriter

Escritor que se va a escribir.

value

Object

Valor que se va a convertir y escribir.

jsonTypeInfo

JsonTypeInfo

Metadatos sobre el tipo que se va a convertir.

Excepciones

ArgumentNullException

writer o jsonTypeInfo es null.

InvalidCastException

value no coincide con el tipo de jsonTypeInfo.

Serialize(Stream, Object, Type, JsonSerializerOptions)

Source:

JsonSerializer.Write.Stream.cs

Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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)

Parámetros

utf8Json

Stream

El UTF-8 Stream en el que se va a escribir.

value

Object

Valor que se va a convertir.

inputType

Type

Tipo del value que se va a convertir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de conversión.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json o inputType es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

Serialize(Object, Type, JsonSerializerOptions)

Source:

JsonSerializer.Write.String.cs

Convierte el valor de un tipo especificado en una cadena 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

Parámetros

value

Object

Valor que se va a convertir.

inputType

Type

Tipo del value que se va a convertir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de conversión.

Devoluciones

String

Representación de cadena JSON del valor.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

inputType es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

Comentarios

El uso de un String no es tan eficaz como el uso de codificación UTF-8, ya que la implementación usa internamente UTF-8. Consulte también SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) y SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Para obtener más información, consulte Cómo serializar y deserializar JSON.

Serialize(Stream, Object, JsonTypeInfo)

Source:

JsonSerializer.Write.Stream.cs

Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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)

Parámetros

utf8Json

Stream

El UTF-8 Stream en el que se va a escribir.

value

Object

Valor que se va a convertir.

jsonTypeInfo

JsonTypeInfo

Metadatos sobre el tipo que se va a convertir.

Excepciones

ArgumentNullException

utf8Json es null.

InvalidCastException

value no coincide con el tipo de jsonTypeInfo.

Serialize(Object, JsonTypeInfo)

Source:

JsonSerializer.Write.String.cs

Convierte el valor proporcionado en un 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

Parámetros

value

Object

Valor que se va a convertir.

jsonTypeInfo

JsonTypeInfo

Metadatos sobre el tipo que se va a convertir.

Devoluciones

String

Representación String del valor.

Excepciones

ArgumentNullException

jsonTypeInfo es null.

InvalidCastException

value no coincide con el tipo de jsonTypeInfo.

Comentarios

El uso de un String no es tan eficaz como el uso de codificación UTF-8, ya que la implementación usa internamente UTF-8. Consulte también SerializeToUtf8Bytes(Object, JsonTypeInfo) y SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken).

Serialize(Object, Type, JsonSerializerContext)

Source:

JsonSerializer.Write.String.cs

Convierte el valor proporcionado en un 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

Parámetros

value

Object

Valor que se va a convertir.

inputType

Type

Tipo del value que se va a convertir.

context

JsonSerializerContext

Proveedor de metadatos para tipos serializables.

Devoluciones

String

Representación String del valor.

Excepciones

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

InvalidOperationException

El método GetTypeInfo(Type) del context proporcionado devuelve null para que el tipo se convierta.

ArgumentNullException

inputType o context es null.

Comentarios

El uso de una String no es tan eficaz como el uso de codificación UTF-8, ya que la implementación usa internamente UTF-8. Consulte también SerializeToUtf8Bytes(Object, Type, JsonSerializerContext) y SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken).

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Source:

JsonSerializer.Write.Utf8JsonWriter.cs

Escribe la representación JSON de un tipo especificado por un parámetro de tipo genérico en el escritor proporcionado.

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)

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

writer

Utf8JsonWriter

Escritor JSON en el que se va a escribir.

value

TValue

Valor que se va a convertir y escribir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de serialización.

Excepciones

ArgumentNullException

writer es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

Comentarios

El JsonWriterOptions usado para crear la instancia del Utf8JsonWriter tiene prioridad sobre el JsonSerializerOptions cuando entran en conflicto. Por lo tanto, se usan JsonWriterOptions.Indented, JsonWriterOptions.SkipValidationy JsonWriterOptions.Encoder al escribir.

Para obtener más información, consulte Cómo serializar y deserializar JSON.

Serialize<TValue>(TValue, JsonSerializerOptions)

Source:

JsonSerializer.Write.String.cs

Convierte el valor de un tipo especificado por un parámetro de tipo genérico en una cadena 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

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

value

TValue

Valor que se va a convertir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de serialización.

Devoluciones

String

Representación de cadena JSON del valor.

Excepciones

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

Comentarios

El uso de un String no es tan eficaz como el uso de codificación UTF-8, ya que la implementación usa internamente UTF-8. Consulte también SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) y SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Para obtener más información, consulte Cómo serializar y deserializar JSON.

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

Source:

JsonSerializer.Write.String.cs

Convierte el valor proporcionado en un 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

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

value

TValue

Valor que se va a convertir.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadatos sobre el tipo que se va a convertir.

Devoluciones

String

Representación String del valor.

Excepciones

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

ArgumentNullException

jsonTypeInfo es null.

Comentarios

El uso de un String no es tan eficaz como el uso de codificación UTF-8, ya que la implementación usa internamente UTF-8. Consulte también SerializeToUtf8Bytes<TValue>(TValue, JsonTypeInfo<TValue>) y SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken).

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Source:

JsonSerializer.Write.Stream.cs

Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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)

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

utf8Json

Stream

El UTF-8 Stream en el que se va a escribir.

value

TValue

Valor que se va a convertir.

options

JsonSerializerOptions

Opciones para controlar el comportamiento de conversión.

Excepciones

ArgumentNullException

utf8Json es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

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

Source:

JsonSerializer.Write.Stream.cs

Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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))

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

utf8Json

Stream

El UTF-8 Stream en el que se va a escribir.

value

TValue

Valor que se va a convertir.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadatos sobre el tipo que se va a convertir.

Excepciones

ArgumentNullException

utf8Json es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

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

Source:

JsonSerializer.Write.Utf8JsonWriter.cs

Escribe un valor JSON (incluidos objetos o matrices) en el escritor proporcionado.

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))

Parámetros de tipo

TValue

Tipo del valor que se va a serializar.

Parámetros

writer

Utf8JsonWriter

Escritor que se va a escribir.

value

TValue

Valor que se va a convertir y escribir.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadatos sobre el tipo que se va a convertir.

Excepciones

ArgumentNullException

writer o jsonTypeInfo es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.