CHANGELOG.md

Changelog

[Unreleased]

Backward compatibility

Version 3.0 is backward incompatible with 2.0 version. Changes are listed here:

• Enum fields are now generated as ProtobufEnumOrUnknown<E>
• Nested messages are now generated in nested mods
• Getters are no longer generated for public fields
• Field accessors (getters and setters) are not generated by default for public fields
• Remove global parse_length_delimited* functions
• PartialEq with large number of fields now panics. Previosly it could cause stack overflow in the Rust compiler.
• Change message_down_cast* functions signatures
• Remove descriptorx from protobuf crate
• well_known_types::Any gets pack, unpack, is operations

New features

• Option to store repeated message fields in Vec instead of RepeatedField. This option may be turned on by default later.
• Similarly, option to store singular field on Option instead of SingularPtrField, which also may be turned on by default later.
• generate_getter option to disable generation of getters functions.
• Flush CodedOutputStream on drop

[2.14] - Unreleased

[2.14.0] - 2020-04-12

• Rename protoc_rust::Args to protoc_rust::Codegen
• Rename protobuf_codegen_pure::Args to protobuf_codegen_pure::Codegen
• protoc-bin-vendored crate introduced

[2.13.0] - 2020-04-09

• Implement Any::pack,is,unpack operations
• Rename protoc::Args to protoc::ProtocLangOut

[2.12.0] - 2020-03-26

• Generated code for reflection now references messages by Protobuf name, not by Rust name.

[2.11.0] - 2020-03-23

Backward compatibility

• Rename ProtobufValueRef to ReflectValueRef. Old name is kept for a while.

Other changes

• Generated code now uses associated constant Lazy::INIT for Lazy intialization instead of initializing fields directly.

[2.10.3] - 2020-03-23

• Oneof names are escaped now in generated code

[2.10.2] - 2020-03-01

• Added dyn to a list of rust keyword needed escaping

[2.10.1] - 2020-01-14

• Remove accidentally slipped into 2.10 version check

[2.10.0] - 2020-01-01

Backward compatibility

• Minimum supported Rust version is 1.40.0 now
• bytes crate upgraded to 0.5

Other changes

• ProtobufError now provides error message in Display instead of Error::description
• Debug is now implemented for EnumValueDescriptor and ReflectValueRef

[2.9] - Unreleased

Changes in 2.9 branch are not included in 2.10.

[2.9.0] - (2019-09-30) yanked

Backward compatibility

• Minimum supported Rust version is 1.34.2 now
• Generated code by protobuf compiler is now compatible only with exactly the same version of protobuf library. Note you can use pure rust protobuf compiler to avoid dependency on protoc binary.
• UnknownFields::fields field is no longer public

Big changes

• Text format and JSON printing and parsing is now implemented
• Mutation reflection is implemented
• All fields are public now except optional or repeated fields when syntax = "proto2", but message fields are public even when syntax = "proto2"

Other changes

• Box<dyn Message> now implements Clone
• Generated code is slightly cleaner now (does not use use statements)
• Generated code no longer uses unsafe (protobuf library still does)
• Add a couple functions to reflection

[2.8] - Unreleased

[2.8.2] - 2019-12-31

• Add async and await to rust keywords

[2.8.1] - 2019-09-06

• hidden lifetime parameters in types are deprecated

[2.8.0] - 2019-07-22

• Fix dyn Trait warning (again)

[2.7.0] - 2019-07-02

• Minimum supported Rust version is 1.27. This version stabilizes dyn Trait syntax.
• inside_protobuf option is added which slightly modifies generated code inside protobuf. Should not affect users.
• Generated files are now compatible only with the same version of runtime
• Fixed codegen for mutually recursive messages with oneofs
• Clippy annotations are now generated as #[allow(clippy::all)] instead of #[allow(clippy)]

[2.6.2] - 2019-06-03

• Fix OOM on malformed input for fields of type bytes::Bytes

[2.6.1] - 2019-05-27

• Fix Hash of UnknownFields
• Improve rustdoc a little

[2.6.0] - 2019-05-19

• lite_runtime rust-protobuf option
• Fix OOM on malformed input
• Minimum supported Rust version is 1.26
• Implement Hash for UnknownFields

[2.5.0] - 2019-04-15

• generate_accessors options to disable generation of accessor functions (except getters).
• Default is now implented for all &MyMessage types
• Debug is now implemented for oneof enums

[2.4.2] - 2019-03-29

• Fix well-known types codegen
• More extension types are supported now

[2.3.1] - 2019-03-05

• Fix codegen when syntax = "proto2" and with-bytes option and string field with default value

[2.3.0] - 2019-01-30

• Default is implemented for enums even in proto2
• Fix codegen where map value is an enum

[2.2.5] - 2019-01-20

• Escape extension field names

[2.2.4] - 2019-01-13

• Replace tempdir dependency with tempfile
• Fix serialization of signed int map keys or values

[2.2.2] - 2018-12-29

• Fix codegen on Windows

[2.2.1] - 2018-12-25

• Fix panic with oneof and bytes codegen

[2.2.0] - 2018-11-17

• Implement From<Option<T>> for SingularPtrField<T>

[2.1.5] - 2019-01-13

• Fix serialization of signed int map keys or values

[2.1.4] - 2018-11-01

• Revert clippy annotations

[2.1.3] - 2018-10-31

• Replace old clippy annotations with recommended new annotations

[2.1.2] - 2018-10-28

• cached_size field is public now

[2.1.1] - 2018-10-09

• Make Customize::_future_options public

[2.1.0] - 2018-10-06

• Support of protoc command from Google protobuf before 3.0 is dropped (it might work, but not tested by CI); this does not affect syntax = "proto2" which is supported
• When using protoc codegen options can now be passed with --rust_opt flag
• Serde is now supported
• unknown_fields field is public now

[2.0.6] - 2019-01-13

• Fix serialization of signed int map keys or values

[2.0.5] - 2018-09-21

• Global parse_length_delimited* functions are deprecated
• Fixed a bug with quotes in string literal parsing in pure codegen

[2.0.4] - 2018-07-19

• Minimum bytes version is 0.4 now (since protobuf doesn't work with 0.3 anyway)

[2.0.3] - 2018-07-11

• Fix panic on singular string field appeared more than once
• Properly handle map fields with key or value skipped in binary proto

[2.0.2] - 2018-05-29

• Make rust-protobuf compatible with rust 1.23.0

[2.0.1] - 2018-05-27

• Fix codegen with enum with default value a reserved rust keyword

[2.0.0] - 2018-05-17

• Rebublished branch 1.6 because of backward compatibility issues in 1.6 branch

[1.7.5] - 2018-05-20

• Fix OOM on malformed input

[1.7.4] - 2018-07-11

• Fix panic on singular string field appeared more than once
• Properly handle map fields with key or value skipped in binary proto

[1.7.3] - 2018-05-29

• Make rust-protobuf compatible with rust 1.23.0

[1.7.2] - 2018-05-27

• Fix codegen with enum with default value a reserved rust keyword

[1.7.1] - 2018-05-17

• Rebublished branch 1.5 because of backward compatibility issues in 1.6 branch

[1.6.0] - 2018-05-11

Republished as 2.0.0

New features

• Pure rust codegen
• Generated code can now be customized not only with rustproto.proto but also when invoked programmatically with protoc-rust
• Oneof are now public by default
• Option to specify recursion limit
• Implement conversions for Repeated*
• Proto files with suffixes others than .proto are now supported
• Generated code now uses closures instead of private functions for reflection

Backward compatibility issues

• Drop MessageStatic trait
• Protobuf no longer exposes internal hex module
• protobuf-codegen is a separate crate
• Drop old reflection accessors. Now code may need to be regenerated when protobuf version changed.
• Implement std::io traits by CodedInputStream and CodedOutputStream
• *descriptor_static() function signatures no longer include Option param (1, 2)

[1.5.1] - 2018-04-02

• Fix serialization or large repeated packed fields

[1.5.0] - 2018-03-25

• Unknown enum values are now stored in unknown fields

[1.4.5] - 2018-04-02

• Fix serialization or large repeated packed fields

[1.4.4] - 2018-03-05

• Escape macro keyword

[1.4.3] - 2017-12-03

• Allow enum variants to be named Self

[1.4.2] - 2017-10-14

• Properly read messages from blocking streams

[1.4.1] - 2017-06-24

• Convert String to Chars

[1.4] - 2017-06-24

• Start of changelog