protobuf library
Runtime library for Dart implementation of protobufs.
Classes
- BuilderInfo
- Per-message type setup.
- ClientContext
- Client side context for RpcClients.
- CodedBufferReader
- Reader used for converting binary-encoded protobufs into GeneratedMessages.
- CodedBufferWriter
- Writer used for converting GeneratedMessages into binary representation.
- EventPlugin
-
An
EventPluginreceives callbacks when the fields of a GeneratedMessage change. -
Extension<
T> - An object representing an extension field.
- ExtensionRegistry
- A collection of Extension objects, organized by the message type they extend.
-
FieldInfo<
T> - An object representing a protobuf message field.
- GeneratedMessage
- The base class for all protobuf message types.
- GeneratedService
- The implementation of a Service API.
- GrpcServiceName
- Use to annotate generated gRPC classes with the ID of the corresponding service.
-
MapFieldInfo<
K, V> -
A FieldInfo subclass for protobuf
mapfields. - PackageName
- The package name of a protobuf message.
- PbFieldType
- Defines constants and functions for dealing with fieldType bits.
-
PbList<
E> -
A ListBase implementation used for protobuf
repeatedfields. -
PbMap<
K, V> -
A MapBase implementation used for protobuf
mapfields. - ProtobufEnum
- A base class for all proto enum types.
- RpcClient
- Client-side transport for making calls to a service.
- ServerContext
- Server side context.
- TagNumber
- Annotation for marking accessors that belong together.
- TypeRegistry
- A TypeRegistry is used to resolve Any messages in the proto3 JSON conversion.
- UnknownFieldSet
- A set of unknown fields in a GeneratedMessage.
- UnknownFieldSetField
- An unknown field in a UnknownFieldSet.
Extensions
- GeneratedMessageGenericExtensions on T
- Extensions on GeneratedMessages.
Typedefs
-
CheckFunc<
E> = void Function(E? x) -
Type of a function that checks items added to a
PbList. - CreateBuilderFunc = GeneratedMessage Function()
- Type of an empty message builder.
- MakeDefaultFunc = dynamic Function()
- Type of a function that creates the default value of a protobuf field.
- ValueOfFunc = ProtobufEnum? Function(int value)
- Type of a function that makes an enum integer value to corresponding ProtobufEnum value.
Exceptions / Errors
- InvalidProtocolBufferException
- Exception thrown by the binary deserializer when the encoding is malformed.