scalapb-runtime/scalapb.options/MessageOptions

MessageOptions

final case class MessageOptions(`extends`: Seq[String], companionExtends: Seq[String], annotations: Seq[String], `type`: Option[String], companionAnnotations: Seq[String], sealedOneofExtends: Seq[String], noBox: Option[Boolean], unknownFieldsAnnotations: Seq[String], noDefaultValuesInConstructor: Option[Boolean], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MessageOptions] with ExtendableMessage[MessageOptions]
Value parameters:
annotations

Custom annotations to add to the generated case class.

companionAnnotations

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

companionExtends

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

extends

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

noBox

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.

noDefaultValuesInConstructor

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.

sealedOneofExtends

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

type

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

unknownFieldsAnnotations

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

Companion:
object
trait Updatable[MessageOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addAllAnnotations(`__vs`: Iterable[String]): MessageOptions
def addAllCompanionAnnotations(`__vs`: Iterable[String]): MessageOptions
def addAllCompanionExtends(`__vs`: Iterable[String]): MessageOptions
def addAllExtends(`__vs`: Iterable[String]): MessageOptions
def addAllSealedOneofExtends(`__vs`: Iterable[String]): MessageOptions
def addAllUnknownFieldsAnnotations(`__vs`: Iterable[String]): MessageOptions
def addAnnotations(`__vs`: String*): MessageOptions
def addCompanionExtends(`__vs`: String*): MessageOptions
def addExtends(`__vs`: String*): MessageOptions
def getFieldByNumber(`__fieldNumber`: Int): Any
def getNoBox: Boolean
def getType: String
override def serializedSize: Int
Definition Classes
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Returns:

human-readable representation of this message.

def withAnnotations(`__v`: Seq[String]): MessageOptions
def withCompanionAnnotations(`__v`: Seq[String]): MessageOptions
def withCompanionExtends(`__v`: Seq[String]): MessageOptions
def withExtends(`__v`: Seq[String]): MessageOptions
def withNoBox(`__v`: Boolean): MessageOptions
def withSealedOneofExtends(`__v`: Seq[String]): MessageOptions
def withType(`__v`: String): MessageOptions
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Inherited methods

def extension[T](generatedExtension: GeneratedExtension[MessageOptions, T]): T
Inherited from:
ExtendableMessage
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Inherited from:
GeneratedMessage
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Inherited from:
GeneratedMessage
final def toPMessage: PMessage
Inherited from:
GeneratedMessage
def update(ms: Lens[MessageOptions, MessageOptions] => () => MessageOptions*): A
Inherited from:
Updatable
def withExtension[T](generatedExtension: GeneratedExtension[MessageOptions, T])(value: T): A
Inherited from:
ExtendableMessage
final def writeDelimitedTo(output: OutputStream): Unit
Inherited from:
GeneratedMessage
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from:
GeneratedMessage