final case class FieldOptions(ctype: scala.Option[CType] = _root_.scala.None, packed: scala.Option[Boolean] = _root_.scala.None, jstype: scala.Option[JSType] = _root_.scala.None, lazy: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, weak: scala.Option[Boolean] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends scalapb.GeneratedMessage with Updatable[FieldOptions] with ExtendableMessage[FieldOptions] with Product with Serializable

ctype

The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

packed

The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding.

jstype

The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

lazy

Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either *always* check its required fields, or *never* check its required fields, regardless of whether or not the message has been parsed.

deprecated

Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.

weak

For Google-internal migration only. Do not use.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

Annotations
@SerialVersionUID()
Linear Supertypes
ExtendableMessage[FieldOptions], Updatable[FieldOptions], scalapb.GeneratedMessage, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldOptions
  2. ExtendableMessage
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FieldOptions(ctype: scala.Option[CType] = _root_.scala.None, packed: scala.Option[Boolean] = _root_.scala.None, jstype: scala.Option[JSType] = _root_.scala.None, lazy: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, weak: scala.Option[Boolean] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    ctype

    The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

    packed

    The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding.

    jstype

    The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

    lazy

    Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either *always* check its required fields, or *never* check its required fields, regardless of whether or not the message has been parsed.

    deprecated

    Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.

    weak

    For Google-internal migration only. Do not use.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See above.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): FieldOptions
  5. def addUninterpretedOption(__vs: UninterpretedOption*): FieldOptions
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearCtype: FieldOptions
  8. def clearDeprecated: FieldOptions
  9. def clearJstype: FieldOptions
  10. def clearLazy: FieldOptions
  11. def clearPacked: FieldOptions
  12. def clearUninterpretedOption: FieldOptions
  13. def clearWeak: FieldOptions
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. def companion: FieldOptions.type
    Definition Classes
    FieldOptions → GeneratedMessage
  16. val ctype: scala.Option[CType]
  17. val deprecated: scala.Option[Boolean]
  18. def discardUnknownFields: FieldOptions
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def extension[T](generatedExtension: GeneratedExtension[FieldOptions, T]): T
    Definition Classes
    ExtendableMessage
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getCtype: CType
  24. def getDeprecated: Boolean
  25. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FieldOptions → GeneratedMessage
  26. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FieldOptions → GeneratedMessage
  27. def getJstype: JSType
  28. def getLazy: Boolean
  29. def getPacked: Boolean
  30. def getWeak: Boolean
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. val jstype: scala.Option[JSType]
  33. val lazy: scala.Option[Boolean]
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. val packed: scala.Option[Boolean]
  38. def productElementNames: Iterator[String]
    Definition Classes
    Product
  39. def serializedSize: Int
    Definition Classes
    FieldOptions → GeneratedMessage
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. 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

    Definition Classes
    GeneratedMessage
  42. 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

    Definition Classes
    GeneratedMessage
  43. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  44. 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.

    Definition Classes
    FieldOptions → GeneratedMessage
  45. val uninterpretedOption: Seq[UninterpretedOption]
  46. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    FieldOptions → ExtendableMessage
  47. def update(ms: (Lens[FieldOptions, FieldOptions]) => Mutation[FieldOptions]*): FieldOptions
    Definition Classes
    Updatable
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. val weak: scala.Option[Boolean]
  52. def withCtype(__v: CType): FieldOptions
  53. def withDeprecated(__v: Boolean): FieldOptions
  54. def withExtension[T](generatedExtension: GeneratedExtension[FieldOptions, T])(value: T): FieldOptions
    Definition Classes
    ExtendableMessage
  55. def withJstype(__v: JSType): FieldOptions
  56. def withLazy(__v: Boolean): FieldOptions
  57. def withPacked(__v: Boolean): FieldOptions
  58. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FieldOptions
  59. def withUnknownFields(__v: scalapb.UnknownFieldSet): FieldOptions
    Definition Classes
    FieldOptions → ExtendableMessage
  60. def withWeak(__v: Boolean): FieldOptions
  61. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  62. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    FieldOptions → GeneratedMessage
  63. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from ExtendableMessage[FieldOptions]

Inherited from Updatable[FieldOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped