colfer
Version 1.8.1
Colfer es un formato de serialización binaria optimizado para velocidad y tamaño.
El compilador colf(1) del proyecto genera código fuente a partir de definiciones de esquemas para ordenar y desarmar estructuras de datos.
Este es un software gratuito y sin trabas lanzado al dominio público. El formato está inspirado en Proto col Buff fer s.
Descargue un compilador prediseñado o ejecute go get -u github.com/pascaldekloe/colfer/cmd/colf para crear uno usted mismo. Los usuarios de Homebrew también pueden brew install colfer .
El comando imprime su propio manual cuando se invoca sin argumentos.
NAME
colf — compile Colfer schemas
SYNOPSIS
colf [-h]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] C [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-s expression] [-l expression] Go [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-x class] [-i interfaces] [-c file]
[-s expression] [-l expression] Java [file ...]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] JavaScript [file ...]
DESCRIPTION
The output is source code for either C, Go, Java or JavaScript.
For each operand that names a file of a type other than
directory, colf reads the content as schema input. For each
named directory, colf reads all files with a .colf extension
within that directory. If no operands are given, the contents of
the current directory are used.
A package definition may be spread over several schema files.
The directory hierarchy of the input is not relevant to the
generated code.
OPTIONS
-b directory
Use a base directory for the generated code. (default ".")
-c file
Insert a code snippet from a file.
-f Normalize the format of all schema input on the fly.
-h Prints the manual to standard error.
-i interfaces
Make all generated classes implement one or more interfaces.
Use commas as a list separator.
-l expression
Set the default upper limit for the number of elements in a
list. The expression is applied to the target language under
the name ColferListMax. (default "64 * 1024")
-p package
Compile to a package prefix.
-s expression
Set the default upper limit for serial byte sizes. The
expression is applied to the target language under the name
ColferSizeMax. (default "16 * 1024 * 1024")
-t files
Supply custom tags with one or more files. Use commas as a list
separator. See the TAGS section for details.
-v Enable verbose reporting to standard error.
-x class
Make all generated classes extend a super class.
TAGS
Tags, a.k.a. annotations, are source code additions for structs
and/or fields. Input for the compiler can be specified with the
-t option. The data format is line-oriented.
<line> :≡ <qual> <space> <code> ;
<qual> :≡ <package> '.' <dest> ;
<dest> :≡ <struct> | <struct> '.' <field> ;
Lines starting with a '#' are ignored (as comments). Java output
can take multiple tag lines for the same struct or field. Each
code line is applied in order of appearance.
EXIT STATUS
The command exits 0 on success, 1 on error and 2 when invoked
without arguments.
EXAMPLES
Compile ./io.colf with compact limits as C:
colf -b src -s 2048 -l 96 C io.colf
Compile ./*.colf with a common parent as Java:
colf -p com.example.model -x com.example.io.IOBean Java
BUGS
Report bugs at <https://github.com/pascaldekloe/colfer/issues>.
Text validation is not part of the marshalling and unmarshalling
process. C and Go just pass any malformed UTF-8 characters. Java
and JavaScript replace unmappable content with the '?' character
(ASCII 63).
SEE ALSO
protoc(1), flatc(1)
Se recomienda enviar el código fuente generado al control de versión respectivo para preservar la coherencia de la compilación y minimizar la necesidad de instalaciones del compilador. Alternativamente, puede utilizar el complemento Maven.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > Las estructuras de datos se definen en archivos .colf . El formato se explica por sí mismo.
// Package demo offers a demonstration.
// These comment lines will end up in the generated code.
package demo
// Course is the grounds where the game of golf is played.
type course struct {
ID uint64
name text
holes []hole
image binary
tags []text
}
type hole struct {
// Lat is the latitude of the cup.
lat float64
// Lon is the longitude of the cup.
lon float64
// Par is the difficulty index.
par uint8
// Water marks the presence of water.
water bool
// Sand marks the presence of sand.
sand bool
}
Vea cómo se ve el código generado en C, Go, Java o JavaScript.
La siguiente tabla muestra cómo se aplican los tipos de datos de Colfer por idioma.
| colfer | do | Ir | Java | javascript |
|---|---|---|---|---|
| booleano | carbonizarse | booleano | booleano | Booleano |
| uint8 | uint8_t | uint8 | byte † | Número |
| uint16 | uint16_t | uint16 | corto † | Número |
| uint32 | uint32_t | uint32 | entero † | Número |
| uint64 | uint64_t | uint64 | largo † | Número ‡ |
| int32 | int32_t | int32 | entero | Número |
| int64 | int64_t | int64 | largo | Número ‡ |
| flotador32 | flotar | flotador32 | flotar | Número |
| flotador64 | doble | flotador64 | doble | Número |
| marca de tiempo | especificación de tiempo | tiempo.Tiempo †† | tiempo.Instantáneo | Fecha + Número |
| texto | carácter constante* + tamaño_t | cadena | Cadena | Cadena |
| binario | uint8_t* + tamaño_t | []byte | byte[] | Uint8Array |
| lista | * + tamaño_t | rebanada | formación | Formación |
Las listas pueden contener puntos flotantes, texto, binarios o estructuras de datos.
Colfer es adecuado para fuentes de datos que no son de confianza, como E/S de red o flujos masivos. La clasificación y la clasificación vienen con protección de tamaño incorporada para garantizar un consumo de memoria predecible. El formato evita las bombas de memoria por diseño.
Es posible que el analizador no produzca resultados con formato incorrecto, independientemente de la entrada de datos. En ningún caso el desclasificador podrá leer fuera de los límites de una serie. Las pruebas Fuzz aún no revelaron ninguna volnurabilidad. La potencia informática es bienvenida.
Los cambios de nombre no afectan el formato de serialización. Se debe cambiar el nombre de los campos obsoletos para desalentar claramente su uso. Para compatibilidad con versiones anteriores, se deben agregar nuevos campos al final de las estructuras colfer. Por tanto, el número de campos puede verse como la versión del esquema.
Colfer pretende ser el formato más rápido y más pequeño sin comprometer la confiabilidad. Consulte la wiki de referencia para obtener una comparación. El rendimiento subóptimo se trata como un error.
