Road map of features

[neuecc]

MessagePack for C# aims to be ultimate serializer for .NET.
Ultimate means fastest and has full featured.

Road map of features.

• Generics - v1.0.0. Standard Serializer.
• NonGenerics - v1.0.0. Fremework requires type and object serialize.
• Dynamic - from v1.2.0. Received by dynamic in deserialize.
• Object Serialize - v1.5.0. In serialization, object should serialized to concrete type.
• Union(Polymorphism, Surrogate, Oneof) - v1.0.0. - serialize/deserialize multiple type.
• Configuration - v1.0.0. Recombination of Resolvers.
• Extensibility - v1.0.0. Resolver and custom formatters.
• Compression - v1.0.0. by LZ4.
• Stream - v1.3.3. limited supported(not true streaming), readStrict:true read strictly from Stream.
• Async - not yet. Maybe it is slow but if System.IO.Pipelines comes?
• Reader/Writer - v1.0.0. Primitive API(MessagePackBinary).
• JSON - v1.3.1. Interoperability to JSON, ToJson and FromJson.
• Private - v1.7.0. access to private member. support private constructor, members #40, Support for internal classes #88
• Circular reference - not yet. Support for circular references in object graph #57
• Pre Code Generation - v1.0.0. for AOT environment like Unity. only for Windows and some lack of features. mpc not parsing MessagePackObject contained in .Net Core class library projects correctly #42
• Typeless(self-describing) - v1.4.0. Type is embeded in binary, like BinaryFormatter.
• Overwrite(Merge) - not yet. Don't create new object in deserialize, protobuf has this feature. Support for deserializing into existing objects #107 [WIP]Implement IOverwriteMessagePackFormatter #110
• Deferred - not yet. deferred deserialization like FlatBuffers or ZeroFormatter. Deferred Deserialization Support like ZeroFormatter/FlatBuffers #109

[alexvaluyskiy]

Some feature requests:

• ISerializable support on .NET Standard 2.0 and .NET (my simple implementation: https://github.com/AkkaNetContrib/Akka.Serialization.MessagePack/blob/dev/Akka.Serialization.MessagePack/Resolvers/SerializableResolver.cs)
• Preserving object references (this is a functional subset of Support for circular references in object graph #57)
• Object cloning API (like in Kryo: https://github.com/EsotericSoftware/kryo)

[crocuis]

Some feature requests :

• v1.7.0. property custom serialize like Json.net

public class Organisation {
  public string Name { get; set; }
  [JsonConverter(typeof(TycoonConverter))]
  public IPerson Owner { get; set; }
}

• Automatic generation of IntKey

[MessagePackObect(Order: ...)]
public class Organisation {
}

[francescocristallo]

Some feature Request:

• camelCase Option

• NullValueHandling = NullValueHandling.Ignore Option (as in Json.net), to avoid serializing null values

[alexvaluyskiy]

NullValueHandling.Ignore

@neuecc Is it make sense for MessagePack?

[neuecc]

@alexvaluyskiy In string key mode, it is valid. MsgPack Serializer in other languages will also work well.

[hiradyazdan]

@neuecc How about in int key mode for raw byte arrays? Can null values be automatically removed beforehand?

[hiradyazdan]

I think it would also make sense if null values are skipped/ignored in int key mode as well where there are multiple schemas for the same type that have different properties (e.g. on different environments than c#). Two possible solution would be either to;

• create multiple classes to contain different properties and keys
• create a custom formatter that handle eliminating/adding extra properties

However, both these solutions require manual manipulation every time there's a change. This would be more cumbersome specially on AOT that needs pre-code generation. However, I was thinking of letting the generator to have an option to either skip or allow null values based on user's requirement or even allow both to create multiple formatters.

[AArnott]

@hiradyazdan This issue is for tracking accepted and planned feature work. Can you please open a separate issue if you wish to continue your suggestion?

[github-actions]

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 5 days.