Class AkavacheBuilderExtensions

Namespace

Akavache.SystemTextJson

Assembly

Akavache.SystemTextJson.dll

Provides extension methods for configuring Akavache to use System.Text.Json serialization.

public static class AkavacheBuilderExtensions

Inheritance

object

AkavacheBuilderExtensions

Methods

UseSystemJsonBsonSerializer(IAkavacheBuilder)

Configures the builder to use System.Text.Json BSON serialization with default options.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder UseSystemJsonBsonSerializer(this IAkavacheBuilder builder)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder is null.

UseSystemJsonBsonSerializer(IAkavacheBuilder, Action<JsonSerializerOptions>)

Configures the builder to use System.Text.Json BSON serialization with options configured through a delegate.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder UseSystemJsonBsonSerializer(this IAkavacheBuilder builder, Action<JsonSerializerOptions> configure)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

configure Action<JsonSerializerOptions>

Action to configure the JSON serializer options for BSON serialization.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

UseSystemJsonBsonSerializer(IAkavacheBuilder, JsonSerializerOptions)

Configures the builder to use System.Text.Json BSON serialization with custom options.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder UseSystemJsonBsonSerializer(this IAkavacheBuilder builder, JsonSerializerOptions settings)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

settings JsonSerializerOptions

The JSON serializer options to use for customizing BSON serialization behavior.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder or settings is null.

UseSystemTextJsonSerializer(IAkavacheBuilder, Action<JsonSerializerOptions>)

Configures the builder to use System.Text.Json serialization with options configured through a delegate.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder UseSystemTextJsonSerializer(this IAkavacheBuilder builder, Action<JsonSerializerOptions> configure)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

configure Action<JsonSerializerOptions>

Action to configure the JSON serializer options.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

WithSerializerSystemTextJson(IAkavacheBuilder)

Configures the builder to use System.Text.Json serialization with default options.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder WithSerializerSystemTextJson(this IAkavacheBuilder builder)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder is null.

WithSerializerSystemTextJson(IAkavacheBuilder, JsonSerializerOptions)

Configures the builder to use System.Text.Json serialization with custom options.

[RequiresUnreferencedCode("Serializers require types to be preserved for serialization.")]
public static IAkavacheBuilder WithSerializerSystemTextJson(this IAkavacheBuilder builder, JsonSerializerOptions settings)

Parameters

builder IAkavacheBuilder

The Akavache builder to configure.

settings JsonSerializerOptions

The JSON serializer options to use for customizing serialization behavior.

Returns

IAkavacheBuilder

The builder instance for fluent configuration.

Exceptions

ArgumentNullException

Thrown when builder or settings is null.