scalapb-runtime/scalapb.options/ScalaPbOptions

ScalaPbOptions

object ScalaPbOptions extends GeneratedMessageCompanion[ScalaPbOptions]
Companion:
class
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any

Type members

Classlikes

final case class AuxEnumOptions(target: Option[String], options: Option[EnumOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[AuxEnumOptions]

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.

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.

Value parameters:
options

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

target

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

Companion:
object
object AuxEnumOptions extends GeneratedMessageCompanion[AuxEnumOptions]
Companion:
class
final case class AuxEnumValueOptions(target: Option[String], options: Option[EnumValueOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[AuxEnumValueOptions]

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.

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.

Value parameters:
options

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

target

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

Companion:
object
object AuxEnumValueOptions extends GeneratedMessageCompanion[AuxEnumValueOptions]
Companion:
class
final case class AuxFieldOptions(target: Option[String], options: Option[FieldOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[AuxFieldOptions]

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.

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.

Value parameters:
options

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

target

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

Companion:
object
object AuxFieldOptions extends GeneratedMessageCompanion[AuxFieldOptions]
Companion:
class
final case class AuxMessageOptions(target: Option[String], options: Option[MessageOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[AuxMessageOptions]

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.

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.

Value parameters:
options

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

target

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

Companion:
object
object AuxMessageOptions extends GeneratedMessageCompanion[AuxMessageOptions]
Companion:
class
sealed abstract class EnumValueNaming(val value: Int) extends GeneratedEnum

Naming convention for generated enum values

Naming convention for generated enum values

Companion:
object
object EnumValueNaming extends GeneratedEnumCompanion[EnumValueNaming]
Companion:
class
sealed abstract class OptionsScope(val value: Int) extends GeneratedEnum

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

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

Companion:
object
object OptionsScope extends GeneratedEnumCompanion[OptionsScope]
Companion:
class
implicit class ScalaPbOptionsLens[UpperPB](_l: Lens[UpperPB, ScalaPbOptions]) extends ObjectLens[UpperPB, ScalaPbOptions]

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror
type ValueType = A

Value members

Concrete methods

def javaDescriptor: Descriptor

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not avaialable in Scala.js or scala-native.

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not avaialable in Scala.js or scala-native.

def of(packageName: Option[String], flatPackage: Option[Boolean], `import`: Seq[String], preamble: Seq[String], singleFile: Option[Boolean], noPrimitiveWrappers: Option[Boolean], primitiveWrappers: Option[Boolean], collectionType: Option[String], preserveUnknownFields: Option[Boolean], objectName: Option[String], scope: Option[OptionsScope], lenses: Option[Boolean], retainSourceCodeInfo: Option[Boolean], mapType: Option[String], noDefaultValuesInConstructor: Option[Boolean], enumValueNaming: Option[EnumValueNaming], enumStripPrefix: Option[Boolean], bytesType: Option[String], javaConversions: Option[Boolean], auxMessageOptions: Seq[AuxMessageOptions], auxFieldOptions: Seq[AuxFieldOptions], auxEnumOptions: Seq[AuxEnumOptions], auxEnumValueOptions: Seq[AuxEnumValueOptions], preprocessors: Seq[String], fieldTransformations: Seq[FieldTransformation], ignoreAllTransformations: Option[Boolean], getters: Option[Boolean], testOnlyNoJavaConversions: Option[Boolean]): ScalaPbOptions
def parseFrom(`_input__`: CodedInputStream): ScalaPbOptions

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]
def fromAscii(s: String): A
def merge(a: ScalaPbOptions, input: CodedInputStream): A

Merges the given message with the additional fields in the steam.

Merges the given message with the additional fields in the steam.

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: InputStream): Option[A]
def parseDelimitedFrom(input: CodedInputStream): Option[A]
def parseFrom(s: Array[Byte]): A
def parseFrom(input: InputStream): A
def streamFromDelimitedInput(input: InputStream): Stream[A]
def toByteArray(a: ScalaPbOptions): Array[Byte]
def validate(s: Array[Byte]): Try[A]
def validateAscii(s: String): Either[TextFormatError, A]

Concrete fields

final val GETTERS_FIELD_NUMBER: 27
final val IMPORT_FIELD_NUMBER: 3
final val LENSES_FIELD_NUMBER: 12
final val MAP_TYPE_FIELD_NUMBER: 14
final val SCOPE_FIELD_NUMBER: 11

Implicits

Implicits

final implicit def ScalaPbOptionsLens[UpperPB](_l: Lens[UpperPB, ScalaPbOptions]): ScalaPbOptionsLens[UpperPB]