Shuttle.Core.Serialization
11.0.0
Prefix Reserved
dotnet add package Shuttle.Core.Serialization --version 11.0.0
NuGet\Install-Package Shuttle.Core.Serialization -Version 11.0.0
<PackageReference Include="Shuttle.Core.Serialization" Version="11.0.0" />
paket add Shuttle.Core.Serialization --version 11.0.0
#r "nuget: Shuttle.Core.Serialization, 11.0.0"
// Install Shuttle.Core.Serialization as a Cake Addin #addin nuget:?package=Shuttle.Core.Serialization&version=11.0.0 // Install Shuttle.Core.Serialization as a Cake Tool #tool nuget:?package=Shuttle.Core.Serialization&version=11.0.0
Shuttle.Core.Serialization
PM> Install-Package Shuttle.Core.Serialization
An implementation of the ISerializer
interface is used to serialize objects into a Stream
.
The DefaultSerializer
makes use of the standard .NET xml serialization functionality.
Methods
Serialize
Stream Serialize(object message);
Task<Stream> SerializeAsync(object message);
Returns the message object
as a Stream
.
Deserialize
object Deserialize(Type type, Stream stream);
Task<object> DeserializeAsync(Type type, Stream stream);
Deserializes the Stream
into an object
of the given type.
ISerializerRootType
The ISerializerRootType
interface is an optional interface that serializer implementations can use that allows the developer to specify explicit object types contained within a root type.
The DefaultSerializer
implements this interface and it is recommended that you explicitly register types with the same name, but in different namespaes, that will be serialized within the same root type to avoid any conflicts later down the line.
For instance, the following two types will cause issues when used in the root Complex
type as they both serialize to the same name and the .Net serializer cannot seem to distinguish the difference:
namespace Serializer.v1
{
public class MovedEvent
{
public string Where { get; set; }
}
}
namespace Serializer.v2
{
public class MovedEvent
{
public string Where { get; set; }
}
}
namespace Serializer
{
public class Complex
{
public v1.MovedEvent { get; set; }
public v2.MovedEvent { get; set; }
}
}
By explicitly specifying the types the DefaultSerializer
will add a namespace that will cause the types to be correctly identified.
AddSerializerType
void AddSerializerType(Type root, Type contained);
Specify the contained
tpe that is used within te root
type somewhere.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
- Shuttle.Core.Contract (>= 11.1.0)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on Shuttle.Core.Serialization:
Package | Downloads |
---|---|
Shuttle.Esb
Contains the core Shuttle.Esb assembly that should always be referenced when building Shuttle.Esb solutions. |
|
Shuttle.Recall
Event sourcing mechanism. |
|
Shuttle.Core.Json
Json.Net implementation of the `ISerializer` interface. |
|
Shuttle.Core.Mediator.OpenTelemetry
OpenTelemetry instrumentation for Shuttle.Core.Mediator implementations. |
GitHub repositories
This package is not used by any popular GitHub repositories.