Class SourceCodeInfo.Types.Location (3.23.0) 

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

Inheritance

object > SourceCodeInfo.Types.Location

Namespace

Google.Protobuf.Reflection

Assembly

Google.Protobuf.dll

Constructors

Location()

public Location()

Location(Location)

public Location(SourceCodeInfo.Types.Location other)
Parameter
Name Description
other SourceCodeInfoTypesLocation

Fields

LeadingCommentsFieldNumber

public const int LeadingCommentsFieldNumber = 3

Field number for the "leading_comments" field.

Field Value
Type Description
int

LeadingDetachedCommentsFieldNumber

public const int LeadingDetachedCommentsFieldNumber = 6

Field number for the "leading_detached_comments" field.

Field Value
Type Description
int

PathFieldNumber

public const int PathFieldNumber = 1

Field number for the "path" field.

Field Value
Type Description
int

SpanFieldNumber

public const int SpanFieldNumber = 2

Field number for the "span" field.

Field Value
Type Description
int

TrailingCommentsFieldNumber

public const int TrailingCommentsFieldNumber = 4

Field number for the "trailing_comments" field.

Field Value
Type Description
int

Properties

Descriptor

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

HasLeadingComments

public bool HasLeadingComments { get; }

Gets whether the "leading_comments" field is set

Property Value
Type Description
bool

HasTrailingComments

public bool HasTrailingComments { get; }

Gets whether the "trailing_comments" field is set

Property Value
Type Description
bool

LeadingComments

public string LeadingComments { get; set; }

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 moo. // // Another line attached to moo. optional double moo = 4;

// Detached comment for corge. This is not leading or trailing comments // to moo 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.

Property Value
Type Description
string

LeadingDetachedComments

public RepeatedField<string> LeadingDetachedComments { get; }
Property Value
Type Description
RepeatedFieldstring

Parser

public static MessageParser<SourceCodeInfo.Types.Location> Parser { get; }
Property Value
Type Description
MessageParserSourceCodeInfoTypesLocation

Path

public RepeatedField<int> Path { get; }

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 occurs. 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).

Property Value
Type Description
RepeatedFieldint

Span

public RepeatedField<int> Span { get; }

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.

Property Value
Type Description
RepeatedFieldint

TrailingComments

public string TrailingComments { get; set; }
Property Value
Type Description
string

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.

ClearLeadingComments()

public void ClearLeadingComments()

Clears the value of the "leading_comments" field

ClearTrailingComments()

public void ClearTrailingComments()

Clears the value of the "trailing_comments" field

Clone()

public SourceCodeInfo.Types.Location Clone()

Creates a deep clone of this object.

Returns
Type Description
SourceCodeInfoTypesLocation

A deep clone of this object.

Equals(Location)

public bool Equals(SourceCodeInfo.Types.Location other)
Parameter
Name Description
other SourceCodeInfoTypesLocation
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(Location)

public void MergeFrom(SourceCodeInfo.Types.Location other)

Merges the given message into this one.

Parameter
Name Description
other SourceCodeInfoTypesLocation
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