Go to file
Jakob Buchgraber 1980e025eb Remove PrimitiveMut and related vtable types
The last callside that used PrimitiveMut was in our enums code. This change makes it so that enums nolonger implement MutProxied and thus no longer need the PrimitiveMut type.

PiperOrigin-RevId: 629017282
2024-04-29 03:42:06 -07:00
.bcr
.github Migrate bazel tests to protobuf-ci. 2024-04-19 10:00:00 -07:00
bazel
benchmarks
build_defs
ci Move the windows path length workarounds out of protobuf-ci 2024-04-18 14:19:16 -07:00
cmake Refactor editions infrastructure to a top-level directory. 2024-04-16 11:13:19 -07:00
conformance upb: implement .mergeFromBuffer() on GeneratedMessage in Dart 2024-04-26 11:14:02 -07:00
csharp Introduce `MessageDescriptor.IsMapType` in C# reflection to make it easier to tell whether a given message was generated by protoc for a map field. 2024-04-25 08:41:44 -07:00
docs Publishes "Editions: Group Migration Issues" to GitHub. 2024-04-18 13:29:05 -07:00
editions Use Emit for ByteSizeLong 2024-04-22 17:32:05 -07:00
editors
examples Migrate bazel tests to protobuf-ci. 2024-04-19 10:00:00 -07:00
java Java Proto Lite: Serialize repeated enums without allocating 2024-04-28 17:30:44 -07:00
lua
objectivec Internal changes. 2024-04-15 14:37:15 -07:00
php Auto-generate files after cl/628095780 2024-04-25 16:28:26 +00:00
pkg Refactored the Java generator into separate packages and targets. 2024-04-18 09:33:28 -07:00
protos
protos_generator
python Add unit test enum showing allocation in repeated enum lists 2024-04-28 17:27:02 -07:00
ruby Auto-generate files after cl/628095780 2024-04-25 16:28:26 +00:00
rust Remove PrimitiveMut and related vtable types 2024-04-29 03:42:06 -07:00
src Remove PrimitiveMut and related vtable types 2024-04-29 03:42:06 -07:00
third_party Fix CMake shared library build using utf8_range and utf8_valid (#14867) 2024-04-18 13:08:38 -07:00
toolchain
upb Change the arena.hpp ::Fuse return type to bool to surface whether the fuse failed. 2024-04-25 12:48:33 -07:00
upb_generator upb: begin to delete the old Dart v2 plugin code 2024-04-25 08:56:02 -07:00
.bazelignore
.bazelrc
.clang-format
.gitignore
.gitmodules
.readthedocs.yml
BUILD.bazel Refactor editions infrastructure to a top-level directory. 2024-04-16 11:13:19 -07:00
CMakeLists.txt Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.txt
Cargo.bazel.lock
Cargo.lock
LICENSE
MODULE.bazel Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00
PrivacyInfo.xcprivacy
Protobuf-C++.podspec Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00
Protobuf.podspec Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00
README.md
SECURITY.md
WORKSPACE
appveyor.bat
appveyor.yml
fix_permissions.sh
generate_descriptor_proto.sh
global.json
google3_export_generated_files.sh
maven_install.json
protobuf.bzl
protobuf_deps.bzl Add a TODO to use Layout::WithStaticSizes in SerialArenaChunk when we update the abseil release. 2024-04-25 07:49:48 -07:00
protobuf_release.bzl
protobuf_version.bzl Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00
regenerate_stale_files.sh Hook up staleness tests to non-bootstrap edition defaults 2024-04-11 14:23:41 -07:00
version.json Updating version.json and repo version numbers to: 28-dev (#16555) 2024-04-18 10:47:14 -07:00

README.md

Protocol Buffers - Google's data interchange format

OpenSSF Scorecard

Copyright 2023 Google LLC

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can learn more about it in protobuf's documentation.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Working With Protobuf Source Code

Most users will find working from supported releases to be the easiest path.

If you choose to work from the head revision of the main branch your build will occasionally be broken by source-incompatible changes and insufficiently-tested (and therefore broken) behavior.

If you are using C++ or otherwise need to build protobuf from source as a part of your project, you should pin to a release commit on a release branch.

This is because even release branches can experience some instability in between release commits.

Protobuf Compiler Installation

The protobuf compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our GitHub release page.

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the Maven repository.

These pre-built binaries are only provided for released versions. If you want to use the github main version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

Language Source
C++ (include C++ runtime and protoc) src
Java java
Python python
Objective-C objectivec
C# csharp
Ruby ruby
Go protocolbuffers/protobuf-go
PHP php
Dart dart-lang/protobuf
JavaScript protocolbuffers/protobuf-javascript

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide.

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation is available at the Protocol Buffers doc site.

Support Policy

Read about our version support policy to stay current on support timeframes for the language libraries.

Developer Community

To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.