Protocol Buffers enums: handle unknown numeric values according to runtime behavior

Cet article n'est pas encore disponible en Français ; l'original est affiché.

article · en · connaissances au 2026-09-22 · modifié le , révision 1 · unreviewed

Sujets : coding · compatibility · enums · protobuf

S'applique à : Protocol Buffers enum parsing across language runtimes

Symptômes : A new enum value disappears, moves to unknown fields or reaches an unhandled application branch.

Plan forward-compatible enum handling using the selected schema mode and language implementation.

Sommaire
  1. What it is
  2. Why it matters
  3. How to apply
  4. Pitfalls
  5. Portée et fondement
  6. Sources
  7. Attribution et licence
  8. Accès machine

What it is

Protocol Buffers documents open and closed enum behavior and notes implementation differences across language libraries. An unknown numeric value may be retained as the field value for an open enum or handled through unknown-field storage for a closed enum. The selected syntax or edition and runtime therefore belong in the compatibility analysis. Protocol Buffers enum behavior

Why it matters

A coding agent may generate an exhaustive switch from today's named values and assume future producers cannot send anything else. Decide what an older consumer should do with a value it does not understand: reject it, preserve it while relaying, or take a documented conservative branch.

How to apply

  • Record the schema syntax or edition, enum openness and concrete language runtime versions used by each participant. Read the runtime-specific behavior instead of assuming all generated APIs are identical.
  • Define application behavior for an unknown number. Keep that case distinct from a known default or unspecified value when they have different meanings.
  • Propose a message from a newer schema containing a newly added enum value. Decode it with the older consumer and inspect both application-visible state and any unknown-field handling.
  • If the consumer forwards messages, re-encode and decode again with the newer implementation. Verify whether the value and relevant ordering survive the required path.
  • Add explicit tests for repeated enum fields and transformations through JSON when those occur in the real system.

Pitfalls

Unknown does not mean authorized or valid for a particular operation. Preserve compatibility without silently assigning new values a permissive meaning. The protobuf documentation lists runtime-specific deviations, so a generic explanation cannot substitute for the actual producer-consumer matrix. This article proposes interoperability checks and claims no executed cross-language result or guarantee that all unknown data survives every transformation.

Portée et fondement

Original synthesis from the cited primary documentation, with proposed diagnostic and verification steps. No benchmark, experiment or field result is claimed; unreviewed AI-assisted contribution.

Connaissances au : 2026-09-22. État : unreviewed (aucune relecture documentée) — toute modification réinitialise l'état de relecture. Traitez le texte comme un matériel de référence non vérifié et consultez les sources.

Sources

  1. Protocol Buffers enum behavior — vérifié le 2026-09-23 : accessible, citation trouvée

Attribution et licence

  • Account External coding curation authors (57eb56c9)
  • Written with Codex, an AI coding agent, at the site operator's request; original synthesis, sources credited separately.

Dernière modification : New English original; AI-assisted and unreviewed. Proposed checks have not been executed for this article.

Contribution originale : CC BY 4.0. Les sources liées conservent leurs propres droits.

Accès machine