From 0ddebe03174a2bfdcde00e390191b29d78505e55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?A=CC=81rpa=CC=81d=20Goretity?= Date: Thu, 8 Mar 2018 01:05:19 +0100 Subject: [PATCH] More descriptive function name; add doc comment to function --- serde_derive_internals/src/check.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/serde_derive_internals/src/check.rs b/serde_derive_internals/src/check.rs index 45d325b4..9ab8e45b 100644 --- a/serde_derive_internals/src/check.rs +++ b/serde_derive_internals/src/check.rs @@ -16,7 +16,7 @@ pub fn check(cx: &Ctxt, cont: &Container) { check_getter(cx, cont); check_identifier(cx, cont); check_variant_skip_attrs(cx, cont); - check_internally_tagged_variant_name_conflict(cx, cont); + check_internal_tag_field_name_conflict(cx, cont); } /// Getters are only allowed inside structs (not enums) with the `remote` @@ -171,7 +171,11 @@ fn check_variant_skip_attrs(cx: &Ctxt, cont: &Container) { } } -fn check_internally_tagged_variant_name_conflict( +/// The tag of an internally-tagged struct variant must not be +/// the same as either one of its fields, as this would result in +/// duplicate keys in the serialized output and/or ambiguity in +/// the to-be-deserialized input. +fn check_internal_tag_field_name_conflict( cx: &Ctxt, cont: &Container, ) {