Table of Contents

Namespace Excalibur.Dispatch.Serialization

Classes

DeserializerTelemetry

Telemetry data for deserializer operations.

DispatchJsonSerializer

JSON serializer using pooled buffers and writers to reduce repeated allocations.

EncryptionMigrationProgress

Represents the progress of a serializer migration operation.

EnvelopeData

Serializer-agnostic result of deserializing a binary inbox or outbox envelope.

MigrationOptions

Options for configuring serializer migration behavior.

PayloadSerializer

Default implementation of IPayloadSerializer using magic byte format detection.

PluggableSerializationOptions

Options for configuring pluggable serialization.

PoolStatistics

Comprehensive statistics for the writer pool.

PropertyDictionary

Adapts an IDictionary<TKey, TValue> of object values to expose nullable values as required by IMessageContext.

SerializableAuthorizationResult

Serializable implementation of IAuthorizationResult for AOT compatibility.

SerializableCausationId

Serializable implementation of ICausationId for AOT compatibility.

SerializableCorrelationId

Serializable implementation of ICorrelationId for AOT compatibility.

SerializableTenantId

Serializable, concrete tenant identifier value-type for AOT compatibility.

SerializableValidationResult

Serializable implementation of IValidationResult for AOT compatibility.

SerializationBuilderExtensions

Format-specific extension methods for ISerializationBuilder.

SerializationException

Exception thrown when serialization or deserialization operations fail.

SerializerExtensions

Convenience extension methods for ISerializer providing overloads for common buffer types (byte[], Stream, ReadOnlyMemory, ReadOnlySequence, string). PipeWriter/PipeReader overloads are in SerializerPipeExtensions (Excalibur.Dispatch package).

SerializerIds

Well-known serializer IDs assigned by the framework for pluggable serialization.

SerializerMigrationService

Service for migrating data between serialization formats in persistence stores.

SerializerPipeExtensions

Extension methods for ISerializer providing PipeWriter/PipeReader overloads.

SerializerRegistryExtensions

Extension methods for ISerializerRegistry.

SerializerTelemetry

Telemetry data for serializer operations.

SpanEventSerializer

Event serializer implementation using the pluggable serialization infrastructure.

SystemTextJsonSerializer

Consolidated System.Text.Json serializer implementing ISerializer.

Structs

MessageHeader

Fixed-size message header for zero-copy serialization.

PooledSerializationResult

Represents a serialization result backed by a pooled buffer with shared disposal ownership.

Interfaces

IBinaryEnvelopeDeserializer

Provides binary envelope deserialization for inbox and outbox messages when an optimized binary serializer (e.g., MemoryPack) is registered.

IMigrationRecord

Represents a record that can be migrated between serialization formats.

IMigrationStore

Interface for stores that support serializer migration operations.

IPayloadSerializer

High-level abstraction for serializing and deserializing payloads with automatic format detection.

ISerializationBuilder

Builder interface for configuring serialization for internal persistence.

ISerializer

Core serialization contract following the System.Text.Json pattern: minimal core interface with convenience overloads as extension methods in SerializerExtensions.

ISerializerRegistry

Registry for managing available pluggable serializers and the currently configured serializer.

Enums

CompressionAlgorithm

Supported compression algorithms for message serialization. This is the single canonical enum — all packages reference this definition.

PoolHealth

Pool health status.

PreWarmStrategy

Pre-warming strategies for the writer pool.

SerializationFormat

Supported serialization formats for message encoding. This is the single canonical enum - all packages reference this definition.

SerializationOperation

The operation being performed when a serialization exception occurred.