object SourceCodeInfo extends GeneratedMessageCompanion[SourceCodeInfo] with Serializable
- Alphabetic
- By Inheritance
- SourceCodeInfo
- Serializable
- Serializable
- GeneratedMessageCompanion
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
Location
(path: Seq[Int] = _root_.scala.collection.Seq.empty, span: Seq[Int] = _root_.scala.collection.Seq.empty, leadingComments: Option[String] = None, trailingComments: Option[String] = None, leadingDetachedComments: Seq[String] = _root_.scala.collection.Seq.empty) extends scalapb.GeneratedMessage with scalapb.Message[Location] with Updatable[Location] with Product with Serializable
- path
Identifies which part of the FileDescriptorProto was defined at this location. Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1; Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).
- span
Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user.
- leadingComments
If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration. A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment. leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field. Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output. Examples: optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2; optional string baz = 3; // Comment attached to baz. // Another line attached to baz. // Comment attached to qux. // // Another line attached to qux. optional double qux = 4; // Detached comment for corge. This is not leading or trailing comments // to qux or corge because there are blank lines separating it from // both. // Detached comment for corge paragraph 2. optional string corge = 5; /* Block comment attached * to corge. Leading asterisks * will be removed. */ /* Block comment attached to * grault. */ optional int32 grault = 6; // ignored detached comments.
- Annotations
- @SerialVersionUID()
- implicit class SourceCodeInfoLens [UpperPB] extends ObjectLens[UpperPB, SourceCodeInfo]
-
type
ValueType = SourceCodeInfo
- Definition Classes
- GeneratedMessageCompanion
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final val LOCATION_FIELD_NUMBER: Int(1)
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
lazy val
defaultInstance: SourceCodeInfo
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
def
enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]
- Definition Classes
- GeneratedMessageCompanion
-
def
enumCompanionForFieldNumber(__fieldNumber: Int): GeneratedEnumCompanion[_]
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fromAscii(s: String): SourceCodeInfo
- Definition Classes
- GeneratedMessageCompanion
-
def
fromFieldsMap(__fieldsMap: Map[FieldDescriptor, Any]): SourceCodeInfo
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
javaDescriptor: Descriptor
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
- implicit def messageCompanion: GeneratedMessageCompanion[SourceCodeInfo]
-
def
messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]
- Definition Classes
- GeneratedMessageCompanion
-
def
messageCompanionForFieldNumber(__number: Int): GeneratedMessageCompanion[_]
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
implicit
def
messageReads: Reads[SourceCodeInfo]
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
lazy val
nestedMessagesCompanions: Seq[GeneratedMessageCompanion[_]]
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
parseDelimitedFrom(input: InputStream): Option[SourceCodeInfo]
- Definition Classes
- GeneratedMessageCompanion
-
def
parseDelimitedFrom(input: CodedInputStream): Option[SourceCodeInfo]
- Definition Classes
- GeneratedMessageCompanion
-
def
parseFrom(s: Array[Byte]): SourceCodeInfo
- Definition Classes
- GeneratedMessageCompanion
-
def
parseFrom(input: InputStream): SourceCodeInfo
- Definition Classes
- GeneratedMessageCompanion
-
def
parseFrom(input: CodedInputStream): SourceCodeInfo
- Definition Classes
- GeneratedMessageCompanion
-
def
scalaDescriptor: Descriptor
- Definition Classes
- SourceCodeInfo → GeneratedMessageCompanion
-
def
streamFromDelimitedInput(input: InputStream): Stream[SourceCodeInfo]
- Definition Classes
- GeneratedMessageCompanion
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toByteArray(a: SourceCodeInfo): Array[Byte]
- Definition Classes
- GeneratedMessageCompanion
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
validate(s: Array[Byte]): Try[SourceCodeInfo]
- Definition Classes
- GeneratedMessageCompanion
-
def
validateAscii(s: String): Either[TextFormatError, SourceCodeInfo]
- Definition Classes
- GeneratedMessageCompanion
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- object Location extends GeneratedMessageCompanion[Location] with Serializable
Deprecated Value Members
-
def
descriptor: Descriptor
- Definition Classes
- GeneratedMessageCompanion
- Annotations
- @deprecated
- Deprecated
(Since version ScalaPB 0.5.47) Use javaDescriptor instead. In a future version this will refer to scalaDescriptor.