Package Usage: go: github.com/jhump/protocompile
Package protocompile provides the entry point for a high performance
native Go protobuf compiler. "Compile" in this case just means parsing
and validating source and generating fully-linked descriptors in the end.
Unlike the protoc command-line tool, this package does not try to use the
descriptors to perform code.
The various sub-packages represent the various compile phases and contain
models for the intermediate results. Those phases follow:
This package provides an easy-to-use interface that does all of the phases
relevant, based on the inputs given. It is also capable of taking advantage
of multiple CPU cores, so a compilation involving thousands of files can be
done very quickly by compiling things in parallel.
A Resolver is how the compiler locates artifacts that are inputs to the
compilation. For example, it can load protobuf source code that must be
processed. A Resolver could also supply some already-compiled dependencies
as fully-linked descriptors, alleviating the need to re-compile them.
A Resolver can provide any of the following in response to a query for an
input.
Compilation will use the Resolver to load the files that are to be compiled
and also to load all dependencies (i.e. other files imported by those being
compiled).
A Compiler accepts a list of file names and produces the list of descriptors.
A Compiler has several fields that control how it works but only the Resolver
field is required. A minimal Compiler, that resolves files by loading them
from the file system based on the current working directory, can be had with
the following simple snippet:
This minimal Compiler will use default parallelism, equal to the number of
CPU cores detected; it will not generate source code info in the resulting
descriptors; and it will fail fast at the first sign of any error. All of
these aspects can be customized by setting other fields.
2 versions
Latest release: over 2 years ago
251 dependent packages
View more package details: https://packages.ecosystem.code.gouv.fr/registries/proxy.golang.org/packages/github.com/jhump/protocompile