|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | - | - |
| base/ | | 22-Oct-2025 | - | 509 | 319 |
| bazel/ | | 22-Oct-2025 | - | 308 | 228 |
| cmake/ | | 22-Oct-2025 | - | 10,756 | 9,965 |
| conformance/ | | 22-Oct-2025 | - | 497 | 421 |
| hash/ | | 22-Oct-2025 | - | 1,547 | 1,053 |
| io/ | | 22-Oct-2025 | - | 3,429 | 2,328 |
| json/ | | 22-Oct-2025 | - | 2,878 | 2,319 |
| lex/ | | 22-Oct-2025 | - | 585 | 365 |
| mem/ | | 22-Oct-2025 | - | 1,323 | 885 |
| message/ | | 22-Oct-2025 | - | 8,621 | 6,408 |
| mini_descriptor/ | | 22-Oct-2025 | - | 2,597 | 1,977 |
| mini_table/ | | 22-Oct-2025 | - | 1,734 | 1,096 |
| port/ | | 22-Oct-2025 | - | 677 | 571 |
| reflection/ | | 22-Oct-2025 | - | 23,174 | 20,608 |
| test/ | | 22-Oct-2025 | - | 2,155 | 1,733 |
| text/ | | 22-Oct-2025 | - | 1,159 | 847 |
| util/ | | 22-Oct-2025 | - | 2,247 | 1,755 |
| wire/ | | 22-Oct-2025 | - | 4,722 | 3,630 |
| BUILD | D | 22-Oct-2025 | 10.3 KiB | 429 | 383 |
| README.md | D | 22-Oct-2025 | 2.3 KiB | 85 | 59 |
| generated_code_support.h | D | 22-Oct-2025 | 1.2 KiB | 35 | 23 |
README.md
1
2# μpb: small, fast C protos
3
4μpb (often written 'upb') is a small
5[protobuf](https://github.com/protocolbuffers/protobuf) implementation written
6in C.
7
8upb is the core runtime for protobuf languages extensions in
9[Ruby](https://github.com/protocolbuffers/protobuf/tree/main/ruby),
10[PHP](https://github.com/protocolbuffers/protobuf/tree/main/php), and
11[Python](https://github.com/protocolbuffers/protobuf/tree/main/python).
12
13While upb offers a C API, the C API & ABI **are not stable**. For this reason,
14upb is not generally offered as a C library for direct consumption, and there
15are no releases.
16
17## Features
18
19upb has comparable speed to protobuf C++, but is an order of magnitude smaller
20in code size.
21
22Like the main protobuf implementation in C++, it supports:
23
24- a generated API (in C)
25- reflection
26- binary & JSON wire formats
27- text format serialization
28- all standard features of protobufs (oneofs, maps, unknown fields, extensions,
29 etc.)
30- full conformance with the protobuf conformance tests
31
32upb also supports some features that C++ does not:
33
34- **optional reflection:** generated messages are agnostic to whether
35 reflection will be linked in or not.
36- **no global state:** no pre-main registration or other global state.
37- **fast reflection-based parsing:** messages loaded at runtime parse
38 just as fast as compiled-in messages.
39
40However there are a few features it does not support:
41
42- text format parsing
43- deep descriptor verification: upb's descriptor validation is not as exhaustive
44 as `protoc`.
45
46## Install
47
48For Ruby, use [RubyGems](https://rubygems.org/gems/google-protobuf):
49
50```
51$ gem install google-protobuf
52```
53
54For PHP, use [PECL](https://pecl.php.net/package/protobuf):
55
56```
57$ sudo pecl install protobuf
58```
59
60For Python, use [PyPI](https://pypi.org/project/protobuf/):
61
62```
63$ sudo pip install protobuf
64```
65
66Alternatively, you can build and install upb using
67[vcpkg](https://github.com/microsoft/vcpkg/) dependency manager:
68
69 git clone https://github.com/Microsoft/vcpkg.git
70 cd vcpkg
71 ./bootstrap-vcpkg.sh
72 ./vcpkg integrate install
73 ./vcpkg install upb
74
75The upb port in vcpkg is kept up to date by microsoft team members and community
76contributors.
77
78If the version is out of date, please
79[create an issue or pull request](https://github.com/Microsoft/vcpkg) on the
80vcpkg repository.
81
82## Contributing
83
84Please see [CONTRIBUTING.md](CONTRIBUTING.md).
85