Class SourceCodeInfo (3.23.0) 

public sealed class SourceCodeInfo : IMessage<SourceCodeInfo>, IEquatable<SourceCodeInfo>, IDeepCloneable<SourceCodeInfo>, IBufferMessage, IMessage

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

Inheritance

object > SourceCodeInfo

Namespace

Google.Protobuf.Reflection

Assembly

Google.Protobuf.dll

Constructors

SourceCodeInfo()

public SourceCodeInfo()

SourceCodeInfo(SourceCodeInfo)

public SourceCodeInfo(SourceCodeInfo other)
Parameter
Name Description
other SourceCodeInfo

Fields

LocationFieldNumber

public const int LocationFieldNumber = 1

Field number for the "location" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Location

public RepeatedField<SourceCodeInfo.Types.Location> Location { get; }

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 descendant. 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.
Property Value
Type Description
RepeatedFieldSourceCodeInfoTypesLocation

Parser

public static MessageParser<SourceCodeInfo> Parser { get; }
Property Value
Type Description
MessageParserSourceCodeInfo

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public SourceCodeInfo Clone()

Creates a deep clone of this object.

Returns
Type Description
SourceCodeInfo

A deep clone of this object.

Equals(SourceCodeInfo)

public bool Equals(SourceCodeInfo other)
Parameter
Name Description
other SourceCodeInfo
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

MergeFrom(SourceCodeInfo)

public void MergeFrom(SourceCodeInfo other)

Merges the given message into this one.

Parameter
Name Description
other SourceCodeInfo
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Extension Methods