-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathserde.d
2392 lines (2016 loc) · 61.4 KB
/
serde.d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/++
This implements common de/serialization routines.
License: $(HTTP www.apache.org/licenses/LICENSE-2.0, Apache-2.0)
Copyright: 2020 Ilya Yaroshenko, Kaleidic Associates Advisory Limited, Symmetry Investments
Authors: Ilya Yaroshenko
Macros:
T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
T4=$(TR $(TDNW $(LREF $1)) $(TD $2) $(TD $3) $(TD $4))
+/
module mir.serde;
import mir.functional: naryFun;
import mir.reflection;
import std.meta: AliasSeq;
import std.traits: TemplateArgsOf, EnumMembers, hasUDA, isAggregateType;
version (D_Exceptions)
{
/++
Serde Exception
+/
class SerdeException : Exception
{
///
this(
string msg,
string file = __FILE__,
size_t line = __LINE__,
Throwable next = null) pure nothrow @nogc @safe
{
super(msg, file, line, next);
}
///
this(
string msg,
Throwable next,
string file = __FILE__,
size_t line = __LINE__,
) pure nothrow @nogc @safe
{
this(msg, file, line, next);
}
SerdeException toMutable() @trusted pure nothrow @nogc const
{
return cast() this;
}
alias toMutable this;
}
/++
Serde Exception with formatting support
+/
class SerdeMirException : SerdeException
{
import mir.exception: MirThrowableImpl, mirExceptionInitilizePayloadImpl;
enum maxMsgLen = 447;
///
mixin MirThrowableImpl;
}
}
/++
Constructs annotated type.
+/
template SerdeAnnotated(T, string annotation)
{
///
@serdeAlgebraicAnnotation(annotation)
@serdeProxy!T
struct SerdeAnnotated
{
///
T value;
///
alias value this;
}
}
/++
Helper enumeration for for serializer .
Use negative `int` values for user defined targets.
+/
enum SerdeTarget : int
{
///
ion,
///
json,
///
cbor,
///
msgpack,
///
yaml,
///
csv,
///
excel,
///
bloomberg,
///
typedJson,
}
/++
Attribute for key overloading during Serialization and Deserialization.
The first argument overloads the key value during serialization unless `serdeKeyOut` is given.
+/
struct serdeKeys
{
///
immutable(string)[] keys;
@trusted pure nothrow @nogc:
///
this(immutable(string)[] keys...) { this.keys = keys; }
}
/++
Attribute for key overloading during serialization.
+/
struct serdeKeyOut
{
///
string key;
@safe pure nothrow @nogc:
///
this(string key) { this.key = key; }
}
/++
The attribute should be used as a hind for scripting languages to register type deserializer in the type system.
The attribute should be applied to a type definition.
+/
enum serdeRegister;
/++
The attribute can be applied to a string-like member that should be de/serialized as an annotation / attribute.
Also, the attribute can be applied on a type to denote that the type should be used to de/serialize annotated value.
This feature is used in $(MIR_PACKAGE mir-ion).
+/
enum serdeAnnotation;
/++
Checks if the type marked with $(LREF serdeAnnotation).
+/
template isAnnotated(T)
{
import mir.serde: serdeAnnotation;
static if (is(T == enum) || isAggregateType!T) {
enum isAnnotated = hasUDA!(T, serdeAnnotation);
static if (isAnnotated)
static assert(__traits(getAliasThis, T).length == 1 || __traits(hasMember, T, "value"), "@serdeAnnotation " ~ T.stringof ~" requires alias this member or `value` member.");
}
else
enum isAnnotated = false;
}
private template serdeIsAnnotationMemberIn(T)
{
enum bool serdeIsAnnotationMemberIn(string member)
= hasUDA!(__traits(getMember, T, member), serdeAnnotation)
&& !hasUDA!(__traits(getMember, T, member), serdeIgnore)
&& !hasUDA!(__traits(getMember, T, member), serdeIgnoreIn);
}
/++
+/
template serdeGetAnnotationMembersIn(T)
{
import std.meta: aliasSeqOf, Filter;
static if (isAggregateType!T)
enum string[] serdeGetAnnotationMembersIn = [Filter!(serdeIsAnnotationMemberIn!T, aliasSeqOf!(DeserializableMembers!T))];
else
enum string[] serdeGetAnnotationMembersIn = null;
}
///
version(mir_test) unittest
{
struct S
{
double data;
@serdeAnnotation
string a;
@serdeAnnotation @serdeIgnoreIn
string b;
@serdeAnnotation @serdeIgnoreOut
string c;
@serdeAnnotation @serdeIgnore
string d;
}
static assert(serdeGetAnnotationMembersIn!int == []);
static assert(serdeGetAnnotationMembersIn!S == ["a", "c"]);
}
private template serdeIsAnnotationMemberOut(T)
{
enum bool serdeIsAnnotationMemberOut(string member)
= hasUDA!(__traits(getMember, T, member), serdeAnnotation)
&& !hasUDA!(__traits(getMember, T, member), serdeIgnore)
&& !hasUDA!(__traits(getMember, T, member), serdeIgnoreOut);
}
/++
+/
template serdeGetAnnotationMembersOut(T)
{
import std.meta: aliasSeqOf, Filter;
static if (isAggregateType!T)
enum string[] serdeGetAnnotationMembersOut = [Filter!(serdeIsAnnotationMemberOut!T, aliasSeqOf!(SerializableMembers!T))];
else
enum string[] serdeGetAnnotationMembersOut = null;
}
///
version(mir_test) unittest
{
struct S
{
double data;
@serdeAnnotation
string a;
@serdeAnnotation @serdeIgnoreIn
string b;
@serdeAnnotation @serdeIgnoreOut
string c;
@serdeAnnotation @serdeIgnore
string d;
@serdeAnnotation enum string e = "e";
static @serdeAnnotation string f() @safe pure nothrow @nogc @property {
return "f";
}
}
static assert(serdeGetAnnotationMembersOut!int == []);
static assert(serdeGetAnnotationMembersOut!S == ["a", "b", "f"]);
}
/++
An annotation / attribute for algebraic types deserialization.
This feature is used in $(MIR_PACKAGE mir-ion) for $(GMREF mir-core, mir,algebraic).
+/
struct serdeAlgebraicAnnotation
{
///
string annotation;
@safe pure nothrow @nogc:
///
this(string annotation) { this.annotation = annotation; }
}
/++
+/
template serdeHasAlgebraicAnnotation(T)
{
static if (isAggregateType!T || is(T == enum))
{
static if (hasUDA!(T, serdeAlgebraicAnnotation))
{
enum serdeHasAlgebraicAnnotation = true;
}
else
static if (__traits(getAliasThis, T).length)
{
T* aggregate;
alias A = typeof(__traits(getMember, aggregate, __traits(getAliasThis, T)));
enum serdeHasAlgebraicAnnotation = .serdeHasAlgebraicAnnotation!A;
}
else
{
enum serdeHasAlgebraicAnnotation = false;
}
}
else
{
enum serdeHasAlgebraicAnnotation = false;
}
}
/++
+/
template serdeGetAlgebraicAnnotation(T)
{
static if (hasUDA!(T, serdeAlgebraicAnnotation))
{
enum string serdeGetAlgebraicAnnotation = getUDA!(T, serdeAlgebraicAnnotation).annotation;
}
else
{
T* aggregate;
alias A = typeof(__traits(getMember, aggregate, __traits(getAliasThis, T)));
enum serdeGetAlgebraicAnnotation = .serdeGetAlgebraicAnnotation!A;
}
}
/++
User defined attribute used to attach a function that returns a deserialization delegate.
The attribute is usefull for scripting languages and dynamic algebraic types.
+/
template serdeDynamicAlgebraic(alias getAlgebraicDeserializerByAnnotation)
{
enum serdeDynamicAlgebraic;
}
///
version(mir_test)
unittest
{
static struct _global
{
alias Deserializer = S delegate(string s, ubyte[] data) @safe pure;
Deserializer getDeserializer(string name) { return map[name]; }
Deserializer[string] map;
@serdeDynamicAlgebraic!getDeserializer
struct S {}
static assert(serdeIsDynamicAlgebraic!S);
static assert(__traits(isSame, serdeGetAlgebraicDeserializer!S, getDeserializer));
}
}
/++
+/
template serdeIsDynamicAlgebraic(T)
{
static if (isAggregateType!T)
{
static if (hasUDA!(T, serdeDynamicAlgebraic))
{
enum serdeIsDynamicAlgebraic = true;
}
else
static if (__traits(getAliasThis, T).length)
{
T* aggregate;
alias A = typeof(__traits(getMember, aggregate, __traits(getAliasThis, T)));
enum serdeIsDynamicAlgebraic = .serdeIsDynamicAlgebraic!A;
}
else
{
enum serdeIsDynamicAlgebraic = false;
}
}
else
{
enum serdeIsDynamicAlgebraic = false;
}
}
/++
+/
template serdeGetAlgebraicDeserializer(T)
{
static if (hasUDA!(T, serdeDynamicAlgebraic))
{
alias serdeGetAlgebraicDeserializer = TemplateArgsOf!(getUDA!(T, serdeDynamicAlgebraic))[0];
}
else
{
T* aggregate;
alias A = typeof(__traits(getMember, aggregate, __traits(getAliasThis, T)));
alias serdeGetAlgebraicDeserializer = .serdeGetAlgebraicDeserializer!A;
}
}
/++
Returns:
immutable array of the input keys for the symbol or enum value
+/
template serdeGetKeysIn(alias symbol)
{
static if (hasUDA!(symbol, serdeAnnotation) || hasUDA!(symbol, serdeIgnore) || hasUDA!(symbol, serdeIgnoreIn))
enum immutable(string)[] serdeGetKeysIn = null;
else
static if (hasUDA!(symbol, serdeKeys))
enum immutable(string)[] serdeGetKeysIn = getUDA!(symbol, serdeKeys).keys;
else
enum immutable(string)[] serdeGetKeysIn = [__traits(identifier, symbol)];
}
/// ditto
immutable(string)[] serdeGetKeysIn(T)(const T value) @trusted pure nothrow @nogc
if (is(T == enum))
{
foreach (i, member; EnumMembers!T)
{{
alias all = __traits(getAttributes, EnumMembers!T[i]);
}}
import std.meta: staticMap;
static immutable ret = [staticMap!(.serdeGetKeysIn, EnumMembers!T)];
static if (__VERSION__ < 2093)
{
final switch (value)
{
foreach (i, member; EnumMembers!T)
{
case member:
return ret[i];
}
}
}
else
{
import mir.enums: getEnumIndex;
uint index = void;
if (getEnumIndex(value, index))
return ret[index];
assert(0);
}
}
///
version(mir_test) unittest
{
struct S
{
int f;
@serdeKeys("D", "t")
int d;
@serdeIgnore
int i;
@serdeIgnoreIn
int ii;
@serdeIgnoreOut
int io;
void p(int) @property {}
}
static assert(serdeGetKeysIn!(S.f) == ["f"]);
static assert(serdeGetKeysIn!(S.d) == ["D", "t"]);
static assert(serdeGetKeysIn!(S.i) == null);
static assert(serdeGetKeysIn!(S.ii) == null);
static assert(serdeGetKeysIn!(S.io) == ["io"]);
static assert(serdeGetKeysIn!(S.p) == ["p"]);
}
///
version(mir_test) unittest
{
enum E
{
@serdeKeys("A", "alpha")
a,
@serdeKeys("B", "beta")
b,
c,
}
static assert (serdeGetKeysIn(E.a) == ["A", "alpha"], serdeGetKeysIn(E.a));
static assert (serdeGetKeysIn(E.c) == ["c"]);
}
/++
Returns:
output key for the symbol or enum value
+/
template serdeGetKeyOut(alias symbol)
{
static if (hasUDA!(symbol, serdeAnnotation) || hasUDA!(symbol, serdeIgnore) || hasUDA!(symbol, serdeIgnoreOut))
enum string serdeGetKeyOut = null;
else
static if (hasUDA!(symbol, serdeKeyOut))
enum string serdeGetKeyOut = getUDA!(symbol, serdeKeyOut).key;
else
static if (hasUDA!(symbol, serdeKeys))
enum string serdeGetKeyOut = getUDA!(symbol, serdeKeys).keys[0];
else
enum string serdeGetKeyOut = __traits(identifier, symbol);
}
///ditto
@safe pure nothrow @nogc
string serdeGetKeyOut(T)(const T value)
if (is(T == enum))
{
foreach (i, member; EnumMembers!T)
{{
alias all = __traits(getAttributes, EnumMembers!T[i]);
}}
static if (__VERSION__ < 2093)
{
import std.meta: staticMap;
static immutable ret = [staticMap!(.serdeGetKeyOut, EnumMembers!T)];
final switch (value)
{
foreach (i, member; EnumMembers!T)
{
case member:
return ret[i];
}
}
}
else
{
import std.meta: staticMap;
import mir.enums: getEnumIndex;
static immutable ret = [staticMap!(.serdeGetKeyOut, EnumMembers!T)];
uint index = void;
if (getEnumIndex(value, index))
return ret[index];
assert(0);
}
}
///
version(mir_test) unittest
{
struct S
{
int f;
@serdeKeys("D", "t")
int d;
@serdeIgnore
int i;
@serdeIgnoreIn
int ii;
@serdeIgnoreOut
int io;
@serdeKeys("P")
@serdeKeyOut("")
void p(int) @property {}
}
static assert(serdeGetKeyOut!(S.f) == "f");
static assert(serdeGetKeyOut!(S.d) == "D");
static assert(serdeGetKeyOut!(S.i) is null);
static assert(serdeGetKeyOut!(S.ii) == "ii");
static assert(serdeGetKeyOut!(S.io) is null);
static assert(serdeGetKeyOut!(S.p) !is null);
static assert(serdeGetKeyOut!(S.p) == "");
}
///
version(mir_test) unittest
{
enum E
{
@serdeKeys("A", "alpha")
a,
@serdeKeys("B", "beta")
@serdeKeyOut("o")
b,
c,
}
static assert (serdeGetKeyOut(E.a) == "A");
static assert (serdeGetKeyOut(E.b) == "o");
static assert (serdeGetKeyOut(E.c) == "c");
}
/++
Attribute used to ignore unexpected keys during an aggregate type deserialization.
+/
enum serdeIgnoreUnexpectedKeys;
/++
Attribute to ignore field.
See_also: $(LREF serdeIgnoreIn) $(LREF serdeIgnoreOut)
+/
enum serdeIgnore;
/++
Attribute to ignore field during deserialization.
See_also: $(LREF serdeIgnoreInIfAggregate)
+/
enum serdeIgnoreIn;
/++
Attribute to ignore field during serialization.
+/
enum serdeIgnoreOut;
/++
Attribute to ignore a field during deserialization when equals to its default value.
Do not use it on void initialized fields or aggregates with void initialized fields, recursively.
+/
enum serdeIgnoreDefault;
///
version(mir_test) unittest
{
struct S
{
@serdeIgnoreDefault
double d = 0; // skips field if 0 during deserialization
}
import std.traits: hasUDA;
static assert(hasUDA!(S.d, serdeIgnoreDefault));
}
/++
+/
/++
Serialization proxy.
+/
struct serdeProxy(T);
///
version(mir_test) unittest
{
import mir.small_string;
struct S
{
@serdeProxy!(SmallString!32)
double d;
}
import std.traits: hasUDA;
static assert(hasUDA!(S.d, serdeProxy));
static assert(hasUDA!(S.d, serdeProxy!(SmallString!32)));
static assert(is(serdeGetProxy!(S.d) == SmallString!32));
}
/++
+/
alias serdeGetProxy(alias symbol) = TemplateArgsOf!(getUDA!(symbol, serdeProxy))[0];
/// Can be applied to @serdeProxy types to make (de)serialization use
/// underlying type through casting. Useful for enums.
enum serdeProxyCast;
/// Equivalent to @serdeProxy!T @serdeProxyCast
alias serdeEnumProxy(T) = AliasSeq!(serdeProxy!T, serdeProxyCast);
/++
Attributes to conditional ignore field during serialization.
The predicate should be aplied to the member, to the aggregate type.
See_also: $(LREF serdeIgnoreOutIfAggregate)
+/
struct serdeIgnoreOutIf(alias pred);
/++
+/
alias serdeGetIgnoreOutIf(alias symbol) = naryFun!(TemplateArgsOf!(getUDA!(symbol, serdeIgnoreOutIf))[0]);
/++
Attributes to conditional ignore field during serialization.
The predicate should be aplied to the aggregate value, not to the member.
See_also: $(LREF serdeIgnoreIfAggregate) $(LREF serdeIgnoreOutIf), $(LREF serdeIgnoreInIfAggregate)
+/
struct serdeIgnoreOutIfAggregate(alias pred);
/++
+/
alias serdeGetIgnoreOutIfAggregate(alias symbol) = naryFun!(TemplateArgsOf!(getUDA!(symbol, serdeIgnoreOutIfAggregate))[0]);
/++
Attributes to conditional ignore field during deserialization.
The attribute should be combined with $(LREF serdeRealOrderedIn) applied on the aggregate.
See_also: $(LREF serdeIgnoreIfAggregate) $(LREF serdeIgnoreOutIfAggregate) $(LREF serdeIgnoreIn)
+/
struct serdeIgnoreInIfAggregate(alias pred);
/++
+/
alias serdeGetIgnoreInIfAggregate(alias symbol) = naryFun!(TemplateArgsOf!(getUDA!(symbol, serdeIgnoreInIfAggregate))[0]);
/++
Attributes to conditional ignore field during serialization and deserialization.
The attribute should be combined with $(LREF serdeRealOrderedIn) applied on the aggregate.
The predicate should be aplied to the aggregate value, not to the member.
See_also: $(LREF serdeIgnoreOutIfAggregate) $(LREF serdeIgnoreInIfAggregate) $ $(LREF serdeIgnore)
+/
struct serdeIgnoreIfAggregate(alias pred);
/++
+/
alias serdeGetIgnoreIfAggregate(alias symbol) = naryFun!(TemplateArgsOf!(getUDA!(symbol, serdeIgnoreIfAggregate))[0]);
/++
Allows to use flexible deserialization rules such as conversion from input string to numeric types.
+/
enum serdeFlexible;
/++
Allows serialize / deserialize fields like arrays.
A range or a container should be iterable for serialization.
Following code should compile:
------
foreach(ref value; yourRangeOrContainer)
{
...
}
------
`put(value)` method is used for deserialization.
See_also: $(MREF serdeIgnoreOut), $(MREF serdeIgnoreIn)
+/
enum serdeLikeList;
/++
Allows serialize / deserialize fields like objects.
Object should have `opApply` method to allow serialization.
Following code should compile:
------
foreach(key, value; yourObject)
{
...
}
------
Object should have only one `opApply` method with 2 argument to allow automatic value type deduction.
`opIndexAssign` or `opIndex` is used for deserialization to support required syntax:
-----
yourObject["key"] = value;
-----
Multiple value types is supported for deserialization.
See_also: $(MREF serdeIgnoreOut), $(MREF serdeIgnoreIn)
+/
enum serdeLikeStruct;
/++
The attribute is used for algebraic deserialization for types like `Variant!(string, S)`
`@serdeFallbackStruct struct S {}`
+/
enum serdeFallbackStruct;
/++
Force serialize / deserialize on fields instead of Range API.
+/
enum serdeFields;
/++
Ignore keys for object and enum members.
Should be applied to members or enum type itself.
+/
enum serdeIgnoreCase;
///
bool hasSerdeIgnoreCase(T)(T value)
if (is(T == enum))
{
static if (hasUDA!(T, serdeIgnoreCase))
{
return true;
}
else
{
foreach (i, member; EnumMembers!T)
{
alias all = __traits(getAttributes, EnumMembers!T[i]);
if (value == member)
return hasUDA!(EnumMembers!T[i], serdeIgnoreCase);
}
assert(0);
}
}
///
version(mir_test) unittest
{
enum E
{
@serdeIgnoreCase
a,
b,
@serdeIgnoreCase
c,
d,
}
static assert(hasSerdeIgnoreCase(E.a));
static assert(!hasSerdeIgnoreCase(E.b));
static assert(hasSerdeIgnoreCase(E.c));
static assert(!hasSerdeIgnoreCase(E.d));
}
///
version(mir_test) unittest
{
@serdeIgnoreCase
enum E
{
a,
b,
c,
d,
}
static assert(hasSerdeIgnoreCase(E.a));
static assert(hasSerdeIgnoreCase(E.b));
static assert(hasSerdeIgnoreCase(E.c));
static assert(hasSerdeIgnoreCase(E.d));
}
/++
Can be applied only to strings fields.
Does not allocate new data when deserializeing. Raw data is used for strings instead of new memory allocation.
Use this attributes only for strings or arrays that would not be used after deallocation.
+/
enum serdeScoped;
/++
Attribute that force deserializer to throw an exception that the field hasn't been not found in the input.
+/
enum serdeRequired;
/++
Attribute that allow deserializer to do not throw an exception if the field hasn't been not found in the input.
+/
enum serdeOptional;
/++
Attribute that allow deserializer to don't throw an exception that the field matches multiple keys in the object.
+/
enum serdeAllowMultiple;
/++
Attributes for in transformation.
Return type of in transformation must be implicitly convertable to the type of the field.
In transformation would be applied after serialization proxy if any.
+/
struct serdeTransformIn(alias fun) {}
/++
Returns: unary function of underlaying alias of $(LREF serdeTransformIn)
+/
alias serdeGetTransformIn(alias value) = naryFun!(TemplateArgsOf!(getUDA!(value, serdeTransformIn))[0]);
/++
Attributes for out transformation.
Return type of out transformation may be differ from the type of the field.
Out transformation would be applied before serialization proxy if any.
+/
struct serdeTransformOut(alias fun) {}
/++
Returns: unary function of underlaying alias of $(LREF serdeTransformOut)
+/
alias serdeGetTransformOut(alias value) = naryFun!(TemplateArgsOf!(getUDA!(value, serdeTransformOut))[0]);
/++
+/
bool serdeParseEnum(E)(scope const char[] str, scope ref E res)
@safe pure nothrow @nogc
if (is(E == enum))
{
import mir.enums: getEnumIndexFromKey, unsafeEnumFromIndex;
import mir.utility: _expect;
uint index = void;
if (getEnumIndexFromKey!(E, hasUDA!(E, serdeIgnoreCase), serdeGetKeysIn)(str, index)._expect(true))
{
res = unsafeEnumFromIndex!E(index);
return true;
}
return false;
}
version(D_Exceptions)
/// ditto
auto serdeParseEnum(E)(scope const char[] str)
@safe pure
if (is(E == enum))
{
import mir.utility: max;
E ret;
if (.serdeParseEnum(str, ret))
return ret;
import mir.exception: MirException;
throw new MirException("Can't deserialzie ", E.stringof, " from string", str[0 .. max($, 128u)]);
}
///
version(mir_test) unittest
{
enum E
{
@serdeKeys("A", "alpha")
a,
@serdeKeys("B", "beta")
b,
c,
}
auto e = E.c;
assert(serdeParseEnum("A", e));
assert(e == E.a);
assert(serdeParseEnum("alpha", e));
assert(e == E.a);
assert(serdeParseEnum("beta", e));
assert(e == E.b);
assert("B".serdeParseEnum!E == E.b);
assert("c".serdeParseEnum!E == E.c);
assert(!serdeParseEnum("C", e));
assert(!serdeParseEnum("Alpha", e));
}
/// Case insensitive
version(mir_test) unittest
{
@serdeIgnoreCase // supported for the whole type
enum E
{
@serdeKeys("A", "alpha")
a,
@serdeKeys("B", "beta")
b,
c,
}
auto e = E.c;
assert(serdeParseEnum("a", e));
assert(e == E.a);
assert(serdeParseEnum("alpha", e));
assert(e == E.a);
assert(serdeParseEnum("BETA", e));
assert(e == E.b);
assert(serdeParseEnum("b", e));
assert(e == E.b);
assert(serdeParseEnum("C", e));
assert(e == E.c);
}
/++
Deserialization member type
+/
template serdeDeserializationMemberType(T, string member)
{
import std.traits: Unqual, Parameters;
T* aggregate;
static if (hasField!(T, member))
{
alias serdeDeserializationMemberType = typeof(__traits(getMember, *aggregate, member));
}
else
static if (__traits(compiles, &__traits(getMember, *aggregate, member)()) || __traits(getOverloads, *aggregate, member).length > 1)
{
alias serdeDeserializationMemberType = typeof(__traits(getMember, *aggregate, member)());
}
else
{
alias serdeDeserializationMemberType = Unqual!(Parameters!(__traits(getMember, *aggregate, member))[0]);
}
}
/// ditto
template serdeDeserializationMemberType(T)
{
///
alias serdeDeserializationMemberType(string member) = .serdeDeserializationMemberType!(T, member);
}
/++
Is deserializable member