Crate protobuf

Library to read and write protocol buffers data.

Rust files from .proto files can be generated with protobuf-codegen, protobuf-codegen-pure crates. See readme on the project github page.

Modules

descriptor

Generated file from google/protobuf/descriptor.proto

ext

Utilities to support “extension” fields.

json

JSON printer and parser which tries to follow protobuf conventions

plugin

Generated file from google/protobuf/compiler/plugin.proto

reflect

Reflection implementation for protobuf types.

rt

Functions and typrs used by generated protobuf code.

rustproto

Generated file from rustproto.proto

text_format

Protobuf “text format” implementation.

well_known_types

Generated code for “well known types”

wire_format

Constants used in serializations.

Structs

Chars

Thin wrapper around Bytes which guarantees that bytes are valid UTF-8 string. Should be API-compatible to String.

CodedInputStream

Buffered read with handy utilities.

CodedOutputStream

Buffered write with handy utilities

MessageField

Wrapper around Option<Box<T>>, convenient newtype.

ProtobufEnumOrUnknown

Protobuf enums with possibly unknown values are preserved in this struct.

UnknownFields

Hold “unknown” fields in parsed message.

UnknownFieldsIter

Iterator over UnknownFields

UnknownValues

Field unknown values.

UnknownValuesIter

Iterator over unknown values

Enums

ProtobufError

Generic protobuf error

UnknownValue

Unknown value.

UnknownValueRef

Reference to unknown value.

Constants

VERSION

protobuf crate version

VERSION_3_0_0_ALPHA_1

This symbol can be referenced to assert that proper version of crate is used

Traits

Clear

anything that can be cleared

Message

Trait implemented for all generated structs for protobuf messages.

MessageDyn

Dynamic-dispatch version of Message.

Oneof

Trait implemented by all oneof types in generated code.

ProtobufEnum

Trait implemented by all protobuf enum types.

Type Definitions

ProtobufResult

Result alias for ProtobufError