SourceCodeInfo

com.google.protobuf.descriptor.SourceCodeInfo
See theSourceCodeInfo companion class

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[SourceCodeInfo, SourceCodeInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

final case class Location(path: Seq[Int], span: Seq[Int], leadingComments: Option[String], trailingComments: Option[String], leadingDetachedComments: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Location]

Value parameters

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.

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.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[Location, Location]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Location.type
implicit class SourceCodeInfoLens[UpperPB](_l: Lens[UpperPB, SourceCodeInfo]) extends ObjectLens[UpperPB, SourceCodeInfo]

Attributes

Supertypes
class ObjectLens[UpperPB, SourceCodeInfo]
trait Lens[UpperPB, SourceCodeInfo]
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 fromJavaProto(javaPbSource: SourceCodeInfo): SourceCodeInfo
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(location: Seq[Location]): SourceCodeInfo
def parseFrom(`_input__`: CodedInputStream): SourceCodeInfo

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

def toJavaProto(scalaPbSource: SourceCodeInfo): SourceCodeInfo

Inherited methods

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

Attributes

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

Attributes

Inherited from:
GeneratedMessageCompanion
def merge(a: SourceCodeInfo, 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: SourceCodeInfo): 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

Implicits

Implicits

final implicit def SourceCodeInfoLens[UpperPB](_l: Lens[UpperPB, SourceCodeInfo]): SourceCodeInfoLens[UpperPB]