Class SerializerExtensions
- Namespace
- Excalibur.Dispatch.Serialization
- Assembly
- Excalibur.Dispatch.Abstractions.dll
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).
public static class SerializerExtensions
- Inheritance
-
SerializerExtensions
- Inherited Members
Remarks
Follows the System.Text.Json pattern: core interface has minimal methods (IBufferWriter + ReadOnlySpan), and this class provides convenience overloads that delegate to the core methods.
Methods
DeserializeAsync<T>(ISerializer, Stream, CancellationToken)
Deserializes a value from a Stream asynchronously.
public static ValueTask<T> DeserializeAsync<T>(this ISerializer serializer, Stream stream, CancellationToken cancellationToken)
Parameters
serializerISerializerThe serializer.
streamStreamThe stream to read from.
cancellationTokenCancellationTokenCancellation token.
Returns
- ValueTask<T>
The deserialized value.
Type Parameters
TThe type to deserialize to.
DeserializeFromString<T>(ISerializer, string)
Deserializes a value from a UTF-8 encoded string.
public static T DeserializeFromString<T>(this ISerializer serializer, string data)
Parameters
serializerISerializerThe serializer.
datastringThe UTF-8 string to deserialize.
Returns
- T
The deserialized value.
Type Parameters
TThe type to deserialize to.
Remarks
This is primarily useful for human-readable serializers (JSON).
Deserialize<T>(ISerializer, ReadOnlySequence<byte>)
Deserializes a value from a ReadOnlySequence<T>.
public static T Deserialize<T>(this ISerializer serializer, ReadOnlySequence<byte> data)
Parameters
serializerISerializerThe serializer.
dataReadOnlySequence<byte>The sequence containing serialized data.
Returns
- T
The deserialized value.
Type Parameters
TThe type to deserialize to.
Deserialize<T>(ISerializer, byte[])
Deserializes a value from a byte array.
public static T Deserialize<T>(this ISerializer serializer, byte[] data)
Parameters
serializerISerializerThe serializer.
databyte[]The byte array containing serialized data.
Returns
- T
The deserialized value.
Type Parameters
TThe type to deserialize to.
Deserialize<T>(ISerializer, ReadOnlyMemory<byte>)
Deserializes a value from a ReadOnlyMemory<T>.
public static T Deserialize<T>(this ISerializer serializer, ReadOnlyMemory<byte> data)
Parameters
serializerISerializerThe serializer.
dataReadOnlyMemory<byte>The memory containing serialized data.
Returns
- T
The deserialized value.
Type Parameters
TThe type to deserialize to.
SerializeAsync<T>(ISerializer, Stream, T, CancellationToken)
Serializes a value to a Stream asynchronously.
public static ValueTask SerializeAsync<T>(this ISerializer serializer, Stream stream, T value, CancellationToken cancellationToken)
Parameters
serializerISerializerThe serializer.
streamStreamThe stream to write to.
valueTThe value to serialize.
cancellationTokenCancellationTokenCancellation token.
Returns
- ValueTask
A task representing the asynchronous operation.
Type Parameters
TThe type to serialize.
SerializeToBytes<T>(ISerializer, T)
Serializes a value to a new byte array.
public static byte[] SerializeToBytes<T>(this ISerializer serializer, T value)
Parameters
serializerISerializerThe serializer.
valueTThe value to serialize.
Returns
- byte[]
A byte array containing the serialized data.
Type Parameters
TThe type to serialize.
SerializeToString<T>(ISerializer, T)
Serializes a value to a UTF-8 encoded string.
public static string SerializeToString<T>(this ISerializer serializer, T value)
Parameters
serializerISerializerThe serializer.
valueTThe value to serialize.
Returns
- string
A UTF-8 string representation of the serialized data.
Type Parameters
TThe type to serialize.
Remarks
This is primarily useful for human-readable serializers (JSON). For binary serializers, the result will be a Base64-like encoding of the raw bytes.