Un esquema para los datos y los bytes

Estoy haciendo Vexil para definir el modelo de datos y la representación binaria de un protocolo en un mismo esquema. Los anchos en bits, los ordinales de campos, las codificaciones de enteros, los límites y las reglas de evolución forman parte de ese contrato.

Las herramientas generan codecs para Rust, TypeScript, Go y Python. Quiero que un mismo valor produzca los mismos bytes entre implementaciones y que los cambios en ese acuerdo se vean antes de publicar una versión.

Qué hace

  • Verifica esquemas y genera codecs.
  • Incluye el hash canónico del esquema en cada destino generado.
  • Clasifica los cambios compatibles y los que rompen la compatibilidad.
  • Ofrece especificaciones normativas del lenguaje y del formato binario, vectores de conformidad compartidos y ejemplos entre lenguajes.

El formato binario no se describe a sí mismo. Los dos extremos compilan el esquema que van a usar y pueden comparar su hash. Eso deja explícito cómo interpretar los bytes, con menos flexibilidad en tiempo de ejecución.

Estado actual

Vexil todavía no llegó a 1.0. Rust y TypeScript tienen la evidencia más amplia sobre código generado. Go y Python cubren una matriz compartida representativa del formato, con menos cobertura que los otros dos destinos. La tabla de soporte, en inglés, explica esas diferencias.

El servidor de lenguaje compilado desde el código actual informa diagnósticos del compilador para documentos de un solo archivo. Todavía no carga proyectos ni ofrece autocompletado, navegación, información al pasar el cursor o formato. Este trabajo es posterior a la CLI publicada.

Código y ejemplos

El sitio del proyecto tiene la documentación y las especificaciones. El repositorio en GitHub contiene el código, los ejemplos y el material de conformidad.

La guía inicial sigue un esquema desde la generación hasta los bytes exactos y una ida y vuelta de codificación y decodificación. El ejemplo entre lenguajes usa el mismo caso de prueba en los cuatro destinos generados.