Class SystemTextJsonSerializer

A serializer implementation using System.Text.Json, replacing the legacy Utf8Json-based LowLevelRequestResponseSerializer.

Inheritance
object
SystemTextJsonSerializer
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class SystemTextJsonSerializer : IOpenSearchSerializer

Constructors

| Edit this page View Source

SystemTextJsonSerializer()

Declaration
public SystemTextJsonSerializer()

Fields

| Edit this page View Source

Instance

Declaration
public static readonly SystemTextJsonSerializer Instance
Field Value
Type Description
SystemTextJsonSerializer

Methods

| Edit this page View Source

Deserialize(Type, Stream)

Deserialize stream to an instance of type

Declaration
public object Deserialize(Type type, Stream stream)
Parameters
Type Name Description
Type type
Stream stream
Returns
Type Description
object
| Edit this page View Source

DeserializeAsync(Type, Stream, CancellationToken)

Deserialize stream to an instance of type

Declaration
public Task<object> DeserializeAsync(Type type, Stream stream, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Type type
Stream stream
CancellationToken cancellationToken
Returns
Type Description
Task<object>
| Edit this page View Source

DeserializeAsync<T>(Stream, CancellationToken)

Deserialize stream to an instance of T

Declaration
public Task<T> DeserializeAsync<T>(Stream stream, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Stream stream
CancellationToken cancellationToken
Returns
Type Description
Task<T>
Type Parameters
Name Description
T
| Edit this page View Source

Deserialize<T>(Stream)

Deserialize stream to an instance of T

Declaration
public T Deserialize<T>(Stream stream)
Parameters
Type Name Description
Stream stream
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

SerializeAsync<T>(T, Stream, SerializationFormatting, CancellationToken)

Serialize an instance of T to stream using formatting.

Declaration
public Task SerializeAsync<T>(T data, Stream stream, SerializationFormatting formatting = SerializationFormatting.None, CancellationToken cancellationToken = default)
Parameters
Type Name Description
T data

The instance of T that we want to serialize
Stream stream

The stream to serialize to
SerializationFormatting formatting

Formatting hint, note no all implementations of IOpenSearchSerializer are able to satisfy this hint.
CancellationToken cancellationToken
Returns
Type Description
Task
Type Parameters
Name Description
T
| Edit this page View Source

Serialize<T>(T, Stream, SerializationFormatting)

Serialize an instance of T to stream using formatting.

Declaration
public void Serialize<T>(T data, Stream stream, SerializationFormatting formatting = SerializationFormatting.None)
Parameters
Type Name Description
T data

The instance of T that we want to serialize
Stream stream

The stream to serialize to
SerializationFormatting formatting

Formatting hint, note no all implementations of IOpenSearchSerializer are able to satisfy this hint.
Type Parameters
Name Description
T

Implements

Extension Methods