From 618f6d663d19382fd80702a968901c983ebcb4fd Mon Sep 17 00:00:00 2001 From: Antonis Geralis Date: Sun, 4 Sep 2022 20:26:51 +0300 Subject: [PATCH] readme: add section --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe4a34c..21536d1 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,18 @@ proc mutate(value: var ClientId; sizeIncreaseHint: int; enforceChanges: bool; r: For aiding the creation of mutate functions, mutators for every supported type are exported by `drchaos/mutator`. -## What's not supported +### User-defined serializers + +User overloads must use the following proc signatures: + +```nim +proc fromData*(data: openArray[byte]; pos: var int; output: var T) +proc toData*(data: var openArray[byte]; pos: var int; input: T) +``` + +This is only necessary for destructor-based types. + +### What's not supported - Polymorphic types, missing serialization support. - References with cycles. A `.noFuzz` custom pragma will be added soon for cursors.