Provides runtime support for a Dart implementation of protobufs.
Typically one do not need to import this library–only libraries generated by the protoc plugin import this library directly.
If your library or application uses generated protobuf libraries, add this library as a dependency.
- Fix: Allow decoding tagnumbers of up to 29 bits. Would fail before with more than 28 bits.
The generated code for a protofile
import public "b.proto"will export the generated code for
Support for proto3 json (json with field names as keys)
- encoding and decoding.
- Support for well-known types.
GeneratedMessage.toProto3Json()to encode and
FieldInfoobjects have a new getter
.protoNamethat gives the non-camel-case name of the field as in the
Breaking: The field-adder methods on
BuilderInfonow takes only named optional arguments. To migrate, update
protoc_pluginto version 18.0.0 or higher.
The field-adder methods on
BuilderInfoall take a new argument
ExtensionRegistry.reparseMessageto reparse extensions deeply, that is it looks at every nested message and tries to reparse extensions from its unknown fields.
0.13.16which accidentally introduced a breaking change, #284. This release is identical to
- Better handling of dummy calls to
BuilderInfo.addwith a tag number of 0. These would trigger assertions before.
- Add new getter
GeneratedMessage.isFrozento query if the message has been frozen.
- Avoid needless copy when reading from a Uint8List buffer.
AddedExtensionRegistry.reparseMessage()` for decoding extensions from unknown fields after the initial decoding.
BuilderInfo.addnow ignores fields with tag number 0. These would never be generated by the protoc_plugin so this is not considered a breaking change.
- Save memory by only initializing
_FieldSet.oneofCasesif the message contains oneofs.
- Fix recursive merging of repeated elements.
- Move 'eventPlugin' callback when setting a field in order to notify observers about field updates in the correct order.
- Fix JSON serialization of unsigned 64-bit fields.
PbMapso that two
PbMaps are equal if they have equal key/value pairs.
- Fixed equality check between messages with and without extensions.
- Add new method
addAllon ExtensionRegistry for more conveniently adding multiple extensions at once.
Add new method
pcon BuilderInfo for adding repeated composite fields and remove redundant type check on items added to a PbList.
Fix issue with parsing map field entries. The values for two different keys would sometimes be merged.
- Include extension fields in GeneratedMessage.toString().
- Fix issue with not being able to read unknown fields after freezing.
Reading an unknown field set after freeze() now returns the existing field set before freezing instead of an empty UnknownFieldSet.
- Breaking change: Fix issue with not being able to read extensions after freezing.
Reading an extension field after freeze() now returns the value set before freezing instead of the default value.
Breaking change: Changed
BuilderInfo.m()to take class and package name of the protobuf message representing the map entry. Also changed
BuilderInfo.addMapFieldas well as the constructors
MapFieldInfo.mapto take a map entry BuilderInfo object.
This mostly affects generated code, which should now be built with protoc_plugin 15.0.0 or newer.
With this change we avoid creating a map entry BuilderInfo object for each PbMap instance, instead it is passed through the static BuilderInfo object in the generated subclasses of GeneratedMessage.
Breaking change: changed semantics of
GeneratedMessage.toBuilder()to only make a shallow copy.
GeneratedMessagehas a new abstract method:
createEmptyInstance()that subclasses must implement.
Proto files must be rebuilt using protoc_plugin 14.0.0 or newer.
- Fix freezing of map fields.
- Fixed problem with recursive merging of sub messages.
- Added support for oneof. To use oneof support use Dart protoc_plugin version 13.0.0.
- Added support for map fields. Map fields are now represented as Dart maps and are accessed through a getter with the same name as the map field. To use the map support, use Dart protoc_plugin version 11.0.0 or newer.
- Added separate getter for
- Added type argument to
ProtobufEnum.initByValuewhich allows the return value to be fully typed.
- Added ProtobufEnum reserved names.
- Added Support for any messages.
- Breaking change: Add
GeneratedMessage.freeze(). A frozen message and its sub-messages cannot be changed.
- Fix problem with encoding negative enum values.
- Fix problem with encoding byte arrays.
- Dart SDK upper constraint raised to declare compatability with Dart 2.0 stable.
- Breaking change: Changed signature of
- More Dart 2 fixes.
- Breaking change: Added generics to RpcClient.invoke(). Proto files must be rebuilt using Dart protoc_plugin version 0.8.0 or newer to match.
- Dart 2 fixes.
- Updated SDK version to 2.0.0-dev.17.0
- Fix hashing for PbList.
- Fix type in PbList.fold() for Dart 2.
- Small performance tweaks for DDC.
- Added fast getters for common types.
- Only pass index instead of both tag and index to accessors.
- Delegate more methods to underlying list in PbList.
- Small fixes for Dart 2.0.
- Added enumValues to FieldInfo. Fixes #63.
- Small performance optimization when deserializing repeated messages from JSON.
- Type annotations for strong mode.
- Use real generic syntax instead of comment-based.
- Support v2 dev SDKs.
- Unknown enum values are ignored when parsing JSON, instead of throwing an exception.
- Resolved a strong-mode error.
- Performance: Avoid excessive cloning in merge.
- Performance: Use code patterns that dart2js handles better.
- fix zigzag function so all coded buffer reader tests work on dart2js.
- make PbMixin constructor public for use within protoc plugin.
- Revert previous change because it causes strong mode type error in the generated code. We will revisit this in a new version of mixin support.
- Use a more refined implementation of
- Performance: eliminate some dynamic calls.
- Bugfix: remove dependency on
Require at least Dart SDK 1.13.
Removed dependency on
- Experimental support for strong mode.
- Fixed an issue with GeneratedMessage operator== and Map mixins
- Added declaration of GeneratedMessage clone method
- Support the latest version of package
- Reorganized internals to improve performance. We now store field values in a list instead of a map. Private properties and methods are all moved to the _FieldSet class. There are new entry points for generated getters, hazzers, and setters. Improved JSON decoding performance.
- Dropped compatibility with .pb.dart files before 0.4.2 by removing internal constants from GeneratedMessage. Also, protoc plugins before 0.5.0 won't work.
- Renamed FieldType to PbFieldType.
0.4.1 - DO NOT USE #
- added FieldType class. It turned out that FieldType is a commonly used name, even in .proto files. This is renamed to PbFieldType in 0.4.2.
- Added support for observing field changes. For now, this can only be enabled by using a mixin to override the eventPlugin getter.
- Removed optional third parameter from setField(). It was only intended for internal use, and could be used to defeat type checks on fields.
- clearExtension() removes the value and extension in all cases. (Before, the extension would be kept and the list cleared for repeated fields.)
- Upcoming: clearField() will require its argument to be a known tag number (which could be an extension). For now, this is only enforced when a mixin provides an eventPlugin.
- Add ReadonlyMessageMixin. The generated message classes use this to for the default values of message fields.
- Add meta.dart which declares reserved names for the plugin.
- Add GeneratedService and ProtobufClient interfaces.
- Add experimental mixins_meta library
- Add experimental PbMapMixin class (in a separate library).
- Fix bug where ExtensionRegistry would not be used for nested messages.
- More docs.
- Added mergeFromMap() and writeToJsonMap()
- Fixed an analyzer warning.
- Bugfix for
setRange(): Do not assume Iterable has a
- Simplify some types used in is checks and correct PbList to match the
- signature of the List setRange method.
- Bugfix for incorrect decoding of protobuf messages: Uint8List views with non-zero offsets were handled incorrectly.
Allow constants as field initial values as well as creation thunks to reduce generated code size.
Improve the performance of reading a protobuf buffer.
Fixed truncation error in least significant bits with large Int64 constants.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: protobuf: ^0.14.3
2. Install it
You can install packages from the command line:
$ pub get
$ flutter pub get
Alternatively, your editor might support
pub get or
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Sep 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.5.0
- pana: 0.12.21
Detected platforms: Flutter, web, other
No platform restriction found in primary library
lib/src/protobuf/mixins/well_known.dart. (-1.49 points)
lib/src/protobuf/mixins/well_known.dart reported 3 hints:
line 85 col 7: DO use curly braces for all flow control structures.
line 472 col 11: Use contains instead of indexOf
line 483 col 11: Use contains instead of indexOf
lib/src/protobuf/pb_map.dart. (-1.49 points)
lib/src/protobuf/pb_map.dart reported 3 hints:
line 36 col 7: DO use curly braces for all flow control structures.
line 79 col 7: DO use curly braces for all flow control structures.
line 89 col 7: DO use curly braces for all flow control structures.
lib/src/protobuf/extension_registry.dart. (-0.50 points)
lib/src/protobuf/extension_registry.dart reported 1 hint:
line 121 col 9: Use isNotEmpty instead of length
Fix additional 4 files with analysis or formatting issues. (-2 points)
Additional issues in the following files:
Maintain an example. (-10 points)
Create a short demo in the
example/ directory to show how to use this package.
Common filename patterns include
protobuf.dart. Packages with multiple examples should provide
For more information see the pub package layout conventions.