scalapb-runtime
API
Generated with
scalapb-runtime/scalapb/scalapb.options/ScalaPbOptions

ScalaPbOptions

scalapb.options.ScalaPbOptions
See theScalaPbOptions companion class
object ScalaPbOptions extends GeneratedMessageCompanion[ScalaPbOptions]

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

final case class AuxEnumOptions(target: Option[String], options: Option[EnumOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, 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. Set to * to apply to all enums in scope.

Attributes

Companion
object
Supertypes
trait Updatable[AuxEnumOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuxEnumOptions extends GeneratedMessageCompanion[AuxEnumOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class AuxEnumValueOptions(target: Option[String], options: Option[EnumValueOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, 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. Set to * to apply to all enum values in scope.

Attributes

Companion
object
Supertypes
trait Updatable[AuxEnumValueOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuxEnumValueOptions extends GeneratedMessageCompanion[AuxEnumValueOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class AuxFieldOptions(target: Option[String], options: Option[FieldOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, 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. Set to * to apply to all fields in scope.

Attributes

Companion
object
Supertypes
trait Updatable[AuxFieldOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuxFieldOptions extends GeneratedMessageCompanion[AuxFieldOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class AuxMessageOptions(target: Option[String], options: Option[MessageOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, 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. Set to * to apply to all messages in scope.

Attributes

Companion
object
Supertypes
trait Updatable[AuxMessageOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuxMessageOptions extends GeneratedMessageCompanion[AuxMessageOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class EnumValueNaming(val value: Int) extends GeneratedEnum

Naming convention for generated enum values

Naming convention for generated enum values

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object AS_IN_PROTO.type
object CAMEL_CASE.type
trait Recognized
class Unrecognized
object EnumValueNaming extends GeneratedEnumCompanion[EnumValueNaming]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
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)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object FILE.type
object PACKAGE.type
trait Recognized
class Unrecognized
object OptionsScope extends GeneratedEnumCompanion[OptionsScope]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
implicit class ScalaPbOptionsLens[UpperPB](_l: Lens[UpperPB, ScalaPbOptions]) extends ObjectLens[UpperPB, ScalaPbOptions]

Attributes

Supertypes
class ObjectLens[UpperPB, ScalaPbOptions]
trait Lens[UpperPB, ScalaPbOptions]
trait Serializable
class Object
trait Matchable
class Any
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type ValueType = A

Attributes

Inherited from:
GeneratedMessageCompanion

Value members

Concrete methods

def enumCompanionForFieldNumber(`__fieldNumber`: Int): GeneratedEnumCompanion[_]
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 available 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 available in Scala.js or scala-native.

Attributes

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], scala3Sources: Option[Boolean], testOnlyNoJavaConversions: Option[Boolean]): ScalaPbOptions
def parseFrom(`_input__`: CodedInputStream): ScalaPbOptions

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def fromAscii(s: String): A

Attributes

Inherited from:
GeneratedMessageCompanion
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.

Attributes

Inherited from:
GeneratedMessageCompanion
def messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: InputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: CodedInputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(s: Array[Byte]): A

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(input: InputStream): A

Attributes

Inherited from:
GeneratedMessageCompanion
def streamFromDelimitedInput(input: InputStream): Stream[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def toByteArray(a: ScalaPbOptions): Array[Byte]

Attributes

Inherited from:
GeneratedMessageCompanion
def validate(s: Array[Byte]): Try[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def validateAscii(s: String): Either[TextFormatError, A]

Attributes

Inherited from:
GeneratedMessageCompanion

Concrete fields

final val BYTES_TYPE_FIELD_NUMBER: 21
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 OBJECT_NAME_FIELD_NUMBER: 10
final val PREAMBLE_FIELD_NUMBER: 4
final val SCOPE_FIELD_NUMBER: 11

Implicits

Implicits

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