Breaking Changes for FastSerialization #2121
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Require an instance of SerializationSettings for serializers and deserializers.
IStreamWriter to allow writers to directly create readers.
usres can't change the set of allowed types after it is set and handed to the deserialization code.
Remove the ability for FastSerialization to create arbitrary types that are specified in serialized files. Instead, force users to register all types before or during serialization. Types can be registered via calls to Deserializer.RegisterType and Deserializer.RegisterFactory. Users can also implement Deserializer.OnUnregisteredType to handle unregistered types encountered during deserialization. It is incumbent on the implementor to not just blindly call Type.GetType in OnUnregisteredType, and instead only create known types.
provide enough context to find the right assembly.
brianrob
commented
Oct 18, 2024
| @@ -1979,49 +2039,31 @@ private IFastSerializable ReadObjectDefinition(Tags tag, StreamLabel objectLabel | |||
|
|
|||
| internal Func<IFastSerializable> GetFactory(string fullName) | |||
There was a problem hiding this comment.
@GrabYourPitchforks, you will be most interested in the changes to GetFactory.
cincuranet
approved these changes
Nov 5, 2024
src/TraceEvent/TraceEvent.Tests/Serialization/FastSerializerTests.cs
Outdated
Show resolved
Hide resolved
|
Thanks @cincuranet. I have made all of the suggested changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements a set of breaking changes for
FastSerialization.Highlights:
SerializationSettingsare now required when creating a stream for use withFastSerialization.Deserializerbefore they can be deserialized. Failure to do so will cause the deserialization operation to fail.More Details:
SerializationConfigurationtoSerializationSettingsand make it a required parameter when creating a stream for use withFastSerialization.SerializationSettingsread-only once passed into a reader or writer implementation by cloning the object whenever a setting is changed.StreamReaderAlignmentfrom an optional parameter to reader constructors to a property onSerializationSettings.Deserializerbefore they can be deserialized. Failure to do so will cause the deserialization operation to fail. Registration can occur via a call toDeserializer.RegisterTypeorDeserializer.RegisterFactory.Deserializeralso supports on-the-fly registration of types and factories via theDeserializer.OnUnregisteredTypeevent.Deserializer.RegisterDefaultFactoryandDeserializer.TypeResolverin favor ofDeserializer.OnUnregisteredTypewhich allows for type resolution and factory creation to be performed in one place instead of two.