Class StackTraceFileLocation

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

More specific location details of a file: its path, precise line and column numbers if applicable, and function name if available. In essence, a pointer to a location in a file

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

Inheritance

object

StackTraceFileLocation

Implements

IMessage<StackTraceFileLocation>

IEquatable<StackTraceFileLocation>

IDeepCloneable<StackTraceFileLocation>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StackTraceFileLocation()

public StackTraceFileLocation()

StackTraceFileLocation(StackTraceFileLocation)

public StackTraceFileLocation(StackTraceFileLocation other)

Parameters

other StackTraceFileLocation

Fields

ColumnFieldNumber

Field number for the "column" field.

public const int ColumnFieldNumber = 3

Field Value

int

FilePathFieldNumber

Field number for the "file_path" field.

public const int FilePathFieldNumber = 1

Field Value

int

FunctionNameFieldNumber

Field number for the "function_name" field.

public const int FunctionNameFieldNumber = 4

Field Value

int

InternalCodeFieldNumber

Field number for the "internal_code" field.

public const int InternalCodeFieldNumber = 5

Field Value

int

LineFieldNumber

Field number for the "line" field.

public const int LineFieldNumber = 2

Field Value

int

Properties

Column

Optional; if possible, SDK should send this. If not provided, set to -1.

public int Column { get; set; }

Property Value

int

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FilePath

Path to source file (absolute or relative). If the paths are relative, ensure that they are all relative to the same root.

public string FilePath { get; set; }

Property Value

string

FunctionName

Function name this line belongs to, if applicable. Used for falling back to stack trace view.

public string FunctionName { get; set; }

Property Value

string

InternalCode

Flag to communicate whether a location should be hidden by default in the stack view.

public bool InternalCode { get; set; }

Property Value

bool

Line

Optional; If possible, SDK should send this -- this is required for displaying the code location. If not provided, set to -1.

public int Line { get; set; }

Property Value

int

Parser

public static MessageParser<StackTraceFileLocation> Parser { get; }

Property Value

MessageParser<StackTraceFileLocation>

Methods

CalculateSize()

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

public int CalculateSize()

Returns

int

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

Clone()

Creates a deep clone of this object.

public StackTraceFileLocation Clone()

Returns

StackTraceFileLocation

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(StackTraceFileLocation)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(StackTraceFileLocation other)

Parameters

other StackTraceFileLocation

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

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

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(StackTraceFileLocation)

Merges the given message into this one.

public void MergeFrom(StackTraceFileLocation other)

Parameters

other StackTraceFileLocation

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

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