package scalapb

Get desktop application:
View/edit binary Protocol Buffers messages

Represents a custom Collection type in Scala. This allows ScalaPB to integrate with collection types that are different enough from the ones in the standard library.

Used in: FieldOptions

• optional string type = 1

  Type of the collection

• optional bool non_empty = 2

  Set to true if this collection type is not allowed to be empty, for example cats.data.NonEmptyList. When true, ScalaPB will not generate `clearX` for the repeated field and not provide a default argument in the constructor.

• optional string adapter = 3

  An Adapter is a Scala object available at runtime that provides certain static methods that can operate on this collection type.

Used in: ScalaPbOptions.AuxEnumOptions

• repeated string extends = 1

  Additional classes and traits to mix in to the base trait

• repeated string companion_extends = 2

  Additional classes and traits to mix in to the companion object.

• optional string type = 3

  All instances of this enum will be converted to this type. An implicit TypeMapper must be present.

• repeated string base_annotations = 4

  Custom annotations to add to the generated enum's base class.

• repeated string recognized_annotations = 5

  Custom annotations to add to the generated trait.

• repeated string unrecognized_annotations = 6

  Custom annotations to add to the generated Unrecognized case class.

Used in: ScalaPbOptions.AuxEnumValueOptions

• repeated string extends = 1

  Additional classes and traits to mix in to an individual enum value.

• optional string scala_name = 2

  Name in Scala to use for this enum value.

• repeated string annotations = 3

  Custom annotations to add to the generated case object for this enum value.

Used in: ScalaPbOptions.AuxFieldOptions

• optional string type = 1

• optional string scala_name = 2

• optional string collection_type = 3

  Can be specified only if this field is repeated. If unspecified, it falls back to the file option named `collection_type`, which defaults to `scala.collection.Seq`.

• optional Collection collection = 8

• optional string key_type = 4

  If the field is a map, you can specify custom Scala types for the key or value.

• optional string value_type = 5

• repeated string annotations = 6

  Custom annotations to add to the field.

• optional string map_type = 7

  Can be specified only if this field is a map. If unspecified, it falls back to the file option named `map_type` which defaults to `scala.collection.immutable.Map`

• optional bool no_default_value_in_constructor = 9

  If true, no default value will be generated for this field in the message constructor. If this field is set, it has the highest precedence and overrides the values at the message-level and file-level.

• optional bool no_box = 30

  Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box

• optional bool required = 31

  Like no_box it does not box a value in Option[T], but also fails parsing when a value is not provided. This enables to emulate required fields in proto3.

Used in: ScalaPbOptions

• optional google.protobuf.FieldDescriptorProto when = 1

• optional MatchType match_type = 2

• optional google.protobuf.FieldOptions set = 3

Used in: FieldTransformation

• CONTAINS = 0

• EXACT = 1

• PRESENCE = 2

Used in: ScalaPbOptions.AuxMessageOptions

• repeated string extends = 1

  Additional classes and traits to mix in to the case class.

• repeated string companion_extends = 2

  Additional classes and traits to mix in to the companion object.

• repeated string annotations = 3

  Custom annotations to add to the generated case class.

• optional string type = 4

  All instances of this message will be converted to this type. An implicit TypeMapper must be present.

• repeated string companion_annotations = 5

  Custom annotations to add to the companion object of the generated class.

• repeated string sealed_oneof_extends = 6

  Additional classes and traits to mix in to generated sealed_oneof base trait.

• optional bool no_box = 7

  If true, when this message is used as an optional field, do not wrap it in an `Option`. This is equivalent of setting `(field).no_box` to true on each field with the message type.

• repeated string unknown_fields_annotations = 8

  Custom annotations to add to the generated `unknownFields` case class field.

• optional bool no_default_values_in_constructor = 9

  If true, no default values will be generated in message constructors. If set (to true or false), the message-level setting overrides the file-level value, and can be overridden by the field-level setting.

• repeated string extends = 1

  Additional traits to mix in to a oneof.

• optional string scala_name = 2

  Name in Scala to use for this oneof field.

• map<string, ScalaPbOptions> options_by_file = 1

Used in: PreprocessorOutput

• optional string package_name = 1

  If set then it overrides the java_package and package.

• optional bool flat_package = 2

  If true, the compiler does not append the proto base file name into the generated package name. If false (the default), the generated scala package name is the package_name.basename where basename is the proto file name without the .proto extension.

• repeated string import = 3

  Adds the following imports at the top of the file (this is meant to provide implicit TypeMappers)

• repeated string preamble = 4

  Text to add to the generated scala file. This can be used only when single_file is true.

• optional bool single_file = 5

  If true, all messages and enums (but not services) will be written to a single Scala file.

• optional bool no_primitive_wrappers = 7

  By default, wrappers defined at https://github.com/google/protobuf/blob/master/src/google/protobuf/wrappers.proto, are mapped to an Option[T] where T is a primitive type. When this field is set to true, we do not perform this transformation.

• optional bool primitive_wrappers = 6

  DEPRECATED. In ScalaPB <= 0.5.47, it was necessary to explicitly enable primitive_wrappers. This field remains here for backwards compatibility, but it has no effect on generated code. It is an error to set both `primitive_wrappers` and `no_primitive_wrappers`.

• optional string collection_type = 8

  Scala type to be used for repeated fields. If unspecified, `scala.collection.Seq` will be used.

• optional bool preserve_unknown_fields = 9

  If set to true, all generated messages in this file will preserve unknown fields.

• optional string object_name = 10

  If defined, sets the name of the file-level object that would be generated. This object extends `GeneratedFileObject` and contains descriptors, and list of message and enum companions.

• optional ScalaPbOptions.OptionsScope scope = 11

  Experimental: scope to apply the given options.

• optional bool lenses = 12

  If true, lenses will be generated.

• optional bool retain_source_code_info = 13

  If true, then source-code info information will be included in the generated code - normally the source code info is cleared out to reduce code size. The source code info is useful for extracting source code location from the descriptors as well as comments.

• optional string map_type = 14

  Scala type to be used for maps. If unspecified, `scala.collection.immutable.Map` will be used.

• optional bool no_default_values_in_constructor = 15

  If true, no default values will be generated in message constructors. This setting can be overridden at the message-level and for individual fields.

• optional ScalaPbOptions.EnumValueNaming enum_value_naming = 16

• optional bool enum_strip_prefix = 17

  Indicate if prefix (enum name + optional underscore) should be removed in scala code Strip is applied before enum value naming changes.

• optional string bytes_type = 21

  Scala type to use for bytes fields.

• optional bool java_conversions = 23

  Enable java conversions for this file.

• repeated ScalaPbOptions.AuxMessageOptions aux_message_options = 18

  List of message options to apply to some messages.

• repeated ScalaPbOptions.AuxFieldOptions aux_field_options = 19

  List of message options to apply to some fields.

• repeated ScalaPbOptions.AuxEnumOptions aux_enum_options = 20

  List of message options to apply to some enums.

• repeated ScalaPbOptions.AuxEnumValueOptions aux_enum_value_options = 22

  List of enum value options to apply to some enum values.

• repeated string preprocessors = 24

  List of preprocessors to apply.

• repeated FieldTransformation field_transformations = 25

• optional bool ignore_all_transformations = 26

  Ignores all transformations for this file. This is meant to allow specific files to opt out from transformations inherited through package-scoped options.

• optional bool getters = 27

  If true, getters will be generated.

• optional bool test_only_no_java_conversions = 999

  For use in tests only. Inhibit Java conversions even when when generator parameters request for it.

AuxEnumOptions enables you to set enum-level options through package-scoped options. This is useful when you can't add a dependency on scalapb.proto from the proto file that defines the enum.

Used in: ScalaPbOptions

• optional string target = 1

  The fully-qualified name of the enum in the proto name space.

• optional EnumOptions options = 2

  Options to apply to the enum. If there are any options defined on the target enum they take precedence over the options.

AuxEnumValueOptions enables you to set enum value level options through package-scoped options. This is useful when you can't add a dependency on scalapb.proto from the proto file that defines the enum.

Used in: ScalaPbOptions

• optional string target = 1

  The fully-qualified name of the enum value in the proto name space.

• optional EnumValueOptions options = 2

  Options to apply to the enum value. If there are any options defined on the target enum value they take precedence over the options.

AuxFieldOptions enables you to set field-level options through package-scoped options. This is useful when you can't add a dependency on scalapb.proto from the proto file that defines the field.

Used in: ScalaPbOptions

• optional string target = 1

  The fully-qualified name of the field in the proto name space.

• optional FieldOptions options = 2

  Options to apply to the field. If there are any options defined on the target message they take precedence over the options.

AuxMessageOptions enables you to set message-level options through package-scoped options. This is useful when you can't add a dependency on scalapb.proto from the proto file that defines the message.

Used in: ScalaPbOptions

• optional string target = 1

  The fully-qualified name of the message in the proto name space.

• optional MessageOptions options = 2

  Options to apply to the message. If there are any options defined on the target message they take precedence over the options.

Naming convention for generated enum values

Used in: ScalaPbOptions

• AS_IN_PROTO = 0

  Enum value names in Scala use the same name as in the proto

• CAMEL_CASE = 1

  Convert enum values to CamelCase in Scala.

Whether to apply the options only to this file, or for the entire package (and its subpackages)

Used in: ScalaPbOptions

• FILE = 0

  Apply the options for this file only (default)

• PACKAGE = 1

  Apply the options for the entire package and its subpackages.