protobuf module - github.com/golang/protobuf - Go Packages (original) (raw)

Go support for Protocol Buffers

This module (github.com/golang/protobuf) contains Go bindings for protocol buffers.

It has been superseded by thegoogle.golang.org/protobufmodule, which contains an updated and simplified API, support for protobuf reflection, and many other improvements. We recommend that new code use the google.golang.org/protobuf module.

Versions v1.4 and later of github.com/golang/protobuf are implemented in terms of google.golang.org/protobuf. Programs which use both modules must use at least version v1.4 of this one.

See thedeveloper guide for protocol buffers in Gofor a general guide for how to get started using protobufs in Go.

Seerelease note documentationfor more information about individual releases of this project.

Seedocumentation for the next major revisionfor more information about the purpose, usage, and history of this project.

Package index

Summary of the packages provided by this module:

• proto: Packageproto provides functions operating on protobuf messages such as cloning, merging, and checking equality, as well as binary serialization and text serialization.
• jsonpb: Packagejsonpb serializes protobuf messages as JSON.
• ptypes: Packageptypes provides helper functionality for protobuf well-known types.
• ptypes/any: Package any is the generated package for google/protobuf/any.proto.
• ptypes/empty: Package empty is the generated package for google/protobuf/empty.proto.
• ptypes/timestamp: Package timestamp is the generated package forgoogle/protobuf/timestamp.proto.
• ptypes/duration: Package duration is the generated package forgoogle/protobuf/duration.proto.
• ptypes/wrappers: Package wrappers is the generated package forgoogle/protobuf/wrappers.proto.
• ptypes/struct: Package structpb is the generated package forgoogle/protobuf/struct.proto.
• protoc-gen-go/descriptor: Package descriptor is the generated package forgoogle/protobuf/descriptor.proto.
• protoc-gen-go/plugin: Package plugin is the generated package forgoogle/protobuf/compiler/plugin.proto.
• protoc-gen-go: The protoc-gen-go binary is a protoc plugin to generate a Go protocol buffer package.

Reporting issues

The issue tracker for this projectis 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 theGo protocol buffer moduleand also the version of theprotocol buffer toolchainbeing used.

Contributing

This project is open-source and accepts contributions. See thecontribution guidefor more information.

Compatibility

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 .proto files. 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, thegeneratorpackage, and all packages underinternal.

Any breaking changes outside of these will be announced 6 months in advance toprotobuf@googlegroups.com.