Interface ISerializationBuilder
- Namespace
- Excalibur.Dispatch.Serialization
- Assembly
- Excalibur.Dispatch.dll
Builder interface for configuring serialization for internal persistence.
public interface ISerializationBuilder
- Extension Methods
Remarks
This builder configures serializers for internal persistence stores (Outbox, Inbox, Event Store). It is separate from transport serialization which handles message wire formats.
Core methods (2): Register(ISerializer, byte), UseCurrent(string). Format-specific convenience methods (format registration, use-current, etc.) are available as extension methods in SerializationBuilderExtensions.
Follows the IdentityBuilder pattern from Microsoft.AspNetCore.Identity
(3 core methods, format-specific as extensions).
Usage:
services.AddDispatch()
.WithSerialization(config =>
{
config.RegisterSystemTextJson(); // extension method
config.UseCurrent("System.Text.Json");
});
Methods
Register(ISerializer, byte)
Registers a serializer with a unique ID.
ISerializationBuilder Register(ISerializer serializer, byte id)
Parameters
serializerISerializerThe serializer implementation.
idbyteThe serializer ID. Use SerializerIds constants for framework serializers or values in the custom range (200-254) for custom serializers.
Returns
- ISerializationBuilder
The builder for method chaining.
Exceptions
- ArgumentNullException
Thrown when serializer is null.
- ArgumentException
Thrown when ID is outside the valid range or already registered.
UseCurrent(string)
Sets the current serializer by name for new messages.
ISerializationBuilder UseCurrent(string serializerName)
Parameters
serializerNamestringThe name of the serializer to use.
Returns
- ISerializationBuilder
The builder for method chaining.
Exceptions
- ArgumentException
Thrown when the serializer name is null or whitespace.