Add nullable option to codec (#2171)

Signed-off-by: Cesar <[email protected]> Co-authored-by: Stephen Buttolph <[email protected]> Co-authored-by: Dan Laine <[email protected]>
ava-labs · Nov 2, 2023 · 36d1630 · 36d1630
1 parent 4957ccb
commit 36d1630
Show file tree

Hide file tree

Showing 4 changed files with 283 additions and 77 deletions.
diff --git a/codec/reflectcodec/struct_fielder.go b/codec/reflectcodec/struct_fielder.go
@@ -18,13 +18,18 @@ const (
 
 	// TagValue is the value the tag must have to be serialized.
 	TagValue = "true"
+
+	// TagValue is the value the tag must have to be serialized, this variant
+	// includes the nullable option
+	TagWithNullableValue = "true,nullable"
 )
 
 var _ StructFielder = (*structFielder)(nil)
 
 type FieldDesc struct {
 	Index       int
 	MaxSliceLen uint32
+	Nullable    bool
 }
 
 // StructFielder handles discovery of serializable fields in a struct.
@@ -82,10 +87,19 @@ func (s *structFielder) GetSerializedFields(t reflect.Type) ([]FieldDesc, error)
 		// Multiple tags per fields can be specified.
 		// Serialize/Deserialize field if it has
 		// any tag with the right value
-		captureField := false
+		var (
+			captureField bool
+			nullable     bool
+		)
 		for _, tag := range s.tags {
-			if field.Tag.Get(tag) == TagValue {
+			switch field.Tag.Get(tag) {
+			case TagValue:
+				captureField = true
+			case TagWithNullableValue:
 				captureField = true
+				nullable = true
+			}
+			if captureField {
 				break
 			}
 		}
@@ -107,6 +121,7 @@ func (s *structFielder) GetSerializedFields(t reflect.Type) ([]FieldDesc, error)
 		serializedFields = append(serializedFields, FieldDesc{
 			Index:       i,
 			MaxSliceLen: maxSliceLen,
+			Nullable:    nullable,
 		})
 	}
 	s.serializedFieldIndices[t] = serializedFields // cache result