Decorator
Decorate classes with attributes and serialize object arrays into a concrete classes.
PM> Package-Install SirJosh3917.Decorator
Code please!
Create a message type.
[Message("ping")]
public class PingMessage {
[Position(0), Required]
public DateTime ReplyTime { get; set; }
}
Deserialize an object[]
to this class.
object[] array = new object[] { DateTime.UtcNow }
PingMessage deserialized = Deserializer.Deserialize<PingMessage>(new BasicMessage("ping", array));
Assert.Equal(array[0], deserialized.ReplyTime);
Deserialization and passing to a method
Deserialize a message to a method.
[Message("a")]
public class MessageA {
[Position(0), Required]
public string Value { get; set; }
}
[Message("b")]
public class MessageB {
[Position(0), Required]
public string Value { get; set; }
}
public class HandleIncomingMessages {
[DeserializedHandler]
public void HandleMessageAs(MessageA msg) {
Console.WriteLine($"A - {msg.Value}");
}
[DeserializedHandler]
public void HandleMessageBs(MessageB msg) {
Console.WriteLine($"B - {msg.Value}");
}
}
HandleIncomingMessages instance = new HandleIncomingMessages();
Deserializer<HandleIncomingMessages>.DeserializeMessageToMethod(instance, new BasicMessage("b", "Hello, "));
Deserializer<HandleIncomingMessages>.DeserializeMessageToMethod(instance, new BasicMessage("a", "World!"));
//At the moment, static isn't handled properly
Deserialization into an enumerable and passing to a method
For receiving multiple instances of the same message, add the Repeatable
attribute.
[Message("chat"), Repeatable]
public class Chat {
[Position(0), Required]
public string Message { get; set; }
}
IEnumerable<Chat> chats = Deserializer.DeserializeRepeats<Chat>(new BasicMessage("chat", "These", "Are", "Multiple", "Messages!"));
foreach(var i in chats) {
Console.WriteLine(i.Message);
}
Serialization
[Message("chat"), Repeatable]
public class Chat {
[Position(0), Required]
public string Message { get; set; }
}
BaseMessage msg = Serializer.Serialize<Chat>(new Chat {
Message = "Test!"
});
// msg.Arguments is an object[] { "Test!" }
// you can also serialize multiple
BaseMessage msg = Serializer.Serialize<Chat>(new Chat[] {
new Chat { Message = "Test!" },
new Chat { Message = "Multiple" },
new Chat { Message = "Things!" },
});
// msg.Arguments is an object[] { "Test!", "Multiple", "Things!" }
Optional
The [Optional]
attribute, can be used to mark a property nonobligatory.
[Message("test")]
public class Example {
[Position(0), Optional]
public string Value { get; set; }
}
Example exmp = Deserializer.Deserialize<Example>(new BasicMessage("test"));
//the above line of code will throw an exception, the message count must be 1
Example exmp = Deserializer.Deserialize<Example>(new BasicMessage("test", null));
//exmp.Value is 'default(string)', a.k.a. 'null'
Example exmp = Deserializer.Deserialize<Example>(new BasicMessage("test", 1929495));
//exmp.Value is 'default(string)', a.k.a. 'null'
Example exmp = Deserializer.Deserialize<Example>(new BasicMessage("test", "value"));
//exmp.Value is "value"
Position
[Position(x)]
specifies which index in the object[]
holds the corresponding value.
[Message("example")]
public class Example {
[Position(3)]
public string MyValue { get; set; }
[Position(1)]
public int TestInt { get; set; }
[Position(2)]
public DateTime Date { get; set; }
[Position(0)]
public short ShortValue { get; set; }
}
BaseMessage bm = Serializer.Serialize<Example>(new Example {
MyValue = "string",
TestInt = 1337,
Date = DateTime.UtcNow,
ShortValue = short.MaxValue
});
// bm.Arguments = new object[] { short.MaxValue, 1337, DateTime.UtcNow, "string" };