Go support for Protocol Buffers
contains Go bindings for protocol buffers.
It has been superseded by the
module, which contains an updated and simplified API,
support for protobuf reflection, and many other improvements.
We recommend that new code use the
Versions v1.4 and later of
github.com/golang/protobuf are implemented
in terms of
Programs which use both modules must use at least version v1.4 of this one.
See the developer guide for protocol buffers in Go for a general guide for how to get started using protobufs in Go.
See release note documentation for more information about individual releases of this project.
See documentation for the next major revision for more information about the purpose, usage, and history of this project.
Summary of the packages provided by this module:
protoprovides functions operating on protobuf messages such as cloning, merging, and checking equality, as well as binary serialization and text serialization.
jsonpbserializes protobuf messages as JSON.
ptypesprovides helper functionality for protobuf well-known types.
anyis the generated package for
emptyis the generated package for
timestampis the generated package for
durationis the generated package for
wrappersis the generated package for
structpbis the generated package for
descriptoris the generated package for
pluginis the generated package for
protoc-gen-gobinary is a protoc plugin to generate a Go protocol buffer package.
The issue tracker for this project is located here.
Please report any issues with a sufficient description of the bug or feature request. Bug reports should ideally be accompanied by a minimal reproduction of the issue. Irreproducible bugs are difficult to diagnose and fix (and likely to be closed after some period of time). Bug reports must specify the version of the Go protocol buffer module and also the version of the protocol buffer toolchain being used.
This project is open-source and accepts contributions. See the contribution guide for more information.
This module and the generated code are expected to be stable over time. However, we reserve the right to make breaking changes without notice for the following reasons:
- Security: A security issue in the specification or implementation may come to light whose resolution requires breaking compatibility. We reserve the right to address such issues.
- Unspecified behavior: There are some aspects of the protocol buffer specification that are undefined. Programs that depend on unspecified behavior may break in future releases.
- Specification changes: It may become necessary to address an inconsistency, incompleteness, or change in the protocol buffer specification, which may affect the behavior of existing programs. We reserve the right to address such changes.
- Bugs: If a package has a bug that violates correctness, a program depending on the buggy behavior may break if the bug is fixed. We reserve the right to fix such bugs.
- Generated additions: We reserve the right to add new declarations to
generated Go packages of
.protofiles. This includes declared constants, variables, functions, types, fields in structs, and methods on types. This may break attempts at injecting additional code on top of what is generated by
protoc-gen-go. Such practice is not supported by this project.
- Internal changes: We reserve the right to add, modify, and remove
internal code, which includes all unexported declarations, the
generatorpackage, and all packages under
Any breaking changes outside of these will be announced 6 months in advance to email@example.com.
Package descriptor provides functions for obtaining the protocol buffer descriptors of generated Go types.
|Package descriptor provides functions for obtaining the protocol buffer descriptors of generated Go types.|
Package jsonpb provides functionality to marshal and unmarshal between a protocol buffer message and JSON.
|Package jsonpb provides functionality to marshal and unmarshal between a protocol buffer message and JSON.|
Package proto provides functionality for handling protocol buffer messages.
|Package proto provides functionality for handling protocol buffer messages.|
protoc-gen-go is a plugin for the Google protocol buffer compiler to generate Go code.
|protoc-gen-go is a plugin for the Google protocol buffer compiler to generate Go code.|
Package generator is deprecated.
|Package generator is deprecated.|
Package grpc is deprecated.
|Package grpc is deprecated.|
Package ptypes provides functionality for interacting with well-known types.
|Package ptypes provides functionality for interacting with well-known types.|
Package gengogrpc contains the gRPC code generator.
|Package gengogrpc contains the gRPC code generator.|