colfer
Version 1.8.1
Colfer é um formato de serialização binária otimizado para velocidade e tamanho.
O compilador do projeto colf(1) gera código-fonte a partir de definições de esquema para empacotar e desempacotar estruturas de dados.
Este é um software gratuito e desimpedido lançado em domínio público. O formato é inspirado nos Protocolos Buff fer s.
Baixe um compilador pré-construído ou execute go get -u github.com/pascaldekloe/colfer/cmd/colf para criar um você mesmo. Os usuários do Homebrew também podem brew install colfer .
O comando imprime seu próprio manual quando invocado sem 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)
Recomenda-se submeter o código-fonte gerado no respectivo controle de versão para preservar a consistência da construção e minimizar a necessidade de instalações do compilador. Alternativamente, você pode usar o plugin Maven.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > As estruturas de dados são definidas em arquivos .colf . O formato é bastante autoexplicativo.
// 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
}
Veja como fica o código gerado em C, Go, Java ou JavaScript.
A tabela a seguir mostra como os tipos de dados Colfer são aplicados por linguagem.
| Colfer | C | Ir | Java | JavaScript |
|---|---|---|---|---|
| bool | personagem | bool | booleano | Booleano |
| uint8 | uint8_t | uint8 | byte † | Número |
| uint16 | uint16_t | uint16 | curto † | Número |
| uint32 | uint32_t | uint32 | interno † | Número |
| uint64 | uint64_t | uint64 | longo † | Número ‡ |
| int32 | int32_t | int32 | interno | Número |
| int64 | int64_t | int64 | longo | Número ‡ |
| float32 | flutuador | float32 | flutuador | Número |
| float64 | dobro | float64 | dobro | Número |
| carimbo de data/hora | especificação de tempo | tempo.Tempo †† | tempo.Instantâneo | Data + Número |
| texto | const char* + tamanho_t | corda | Corda | Corda |
| binário | uint8_t* + tamanho_t | []byte | byte[] | Uint8Array |
| lista | * + tamanho_t | fatiar | variedade | Variedade |
As listas podem conter pontos flutuantes, texto, binários ou estruturas de dados.
Colfer é adequado para fontes de dados não confiáveis, como E/S de rede ou fluxos em massa. A organização e a desorganização vêm com proteção de tamanho integrada para garantir um consumo de memória previsível. O formato evita bombas de memória por design.
O empacotador não pode produzir saída malformada, independentemente da entrada de dados. Em nenhum caso o desempacotador poderá ler fora dos limites de uma série. O teste Fuzz ainda não revelou nenhuma vulnerabilidade. O poder da computação é bem-vindo.
As alterações de nome não afetam o formato de serialização. Os campos obsoletos devem ser renomeados para desencorajar claramente seu uso. Para compatibilidade com versões anteriores, novos campos devem ser adicionados ao final das estruturas colfer. Assim, o número de campos pode ser visto como a versão do esquema.
Colfer pretende ser o formato mais rápido e menor sem comprometer a confiabilidade. Veja o wiki de benchmark para uma comparação. O desempenho abaixo do ideal é tratado como um bug.
