SourceCodeInfo

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

location

A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools.

For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1).

Notes:

A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index.
Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path.
A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block.
Just because a location's span is a subset of some other location's span does not mean that it is a descendent. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap.
Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future.

Annotations: @SerialVersionUID( 0L )

Linear Supertypes

Product, Equals, Updatable[SourceCodeInfo], scalapb.Message[SourceCodeInfo], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new SourceCodeInfo(location: Seq[Location] = scala.collection.Seq.empty[Nothing])
location
A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools.
For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
Notes:
- A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index.
- Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path.
- A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block.
- Just because a location's span is a subset of some other location's span does not mean that it is a descendent. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap.
- Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def addAllLocation(__vs: TraversableOnce[Location]): SourceCodeInfo
def addLocation(__vs: Location*): SourceCodeInfo
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearLocation: SourceCodeInfo
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def companion: SourceCodeInfo.type

Definition Classes
SourceCodeInfo → GeneratedMessage
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getField(__field: FieldDescriptor): PValue

Definition Classes
SourceCodeInfo → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
SourceCodeInfo → GeneratedMessage
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val location: Seq[Location]

A Location identifies a piece of source code in a .
A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools.
For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
Notes:
- A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index.
- Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path.
- A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block.
- Just because a location's span is a subset of some other location's span does not mean that it is a descendent. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap.
- Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future.
def mergeFrom(_input__: CodedInputStream): SourceCodeInfo

Definition Classes
SourceCodeInfo → Message
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def serializedSize: Int

Definition Classes
SourceCodeInfo → GeneratedMessage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
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
SourceCodeInfo → GeneratedMessage
def update(ms: (Lens[SourceCodeInfo, SourceCodeInfo]) ⇒ (SourceCodeInfo) ⇒ SourceCodeInfo*): SourceCodeInfo

Definition Classes
Updatable
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( ... )
def withLocation(__v: Seq[Location]): SourceCodeInfo
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
SourceCodeInfo → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

final case class SourceCodeInfo(location: Seq[Location] = scala.collection.Seq.empty[Nothing]) extends scalapb.GeneratedMessage with scalapb.Message[SourceCodeInfo] with Updatable[SourceCodeInfo] with Product with Serializable

Instance Constructors

new SourceCodeInfo(location: Seq[Location] = scala.collection.Seq.empty[Nothing])

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addAllLocation(__vs: TraversableOnce[Location]): SourceCodeInfo

def addLocation(__vs: Location*): SourceCodeInfo

final def asInstanceOf[T0]: T0

def clearLocation: SourceCodeInfo

def clone(): AnyRef

def companion: SourceCodeInfo.type

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

final def isInstanceOf[T0]: Boolean

val location: Seq[Location]

def mergeFrom(_input__: CodedInputStream): SourceCodeInfo

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def serializedSize: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

def update(ms: (Lens[SourceCodeInfo, SourceCodeInfo]) ⇒ (SourceCodeInfo) ⇒ SourceCodeInfo*): SourceCodeInfo

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withLocation(__v: Seq[Location]): SourceCodeInfo

def writeDelimitedTo(output: OutputStream): Unit

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

def getField(field: FieldDescriptor): Any

Inherited from Product

Inherited from Equals

Inherited from Updatable[SourceCodeInfo]

Inherited from scalapb.Message[SourceCodeInfo]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped