Interface ITraceWriter

Definition

Namespace: StardewUI.Diagnostics
Assembly: StardewUI.dll

Abstract output writer for performance traces.

public interface ITraceWriter

This is an internal helper meant for use by the Trace utility and should not be used directly by mods.

Name	Description
IsTracing	Whether or not a trace has been started, and not yet ended.

Name	Description
BeginSlice(string)	Begins tracking a new operation (slice).
BeginTrace()	Starts a new trace.
EndTrace()	Ends the current trace and writes all recorded data to a new trace file in the output directory.

Whether or not a trace has been started, and not yet ended.

bool IsTracing { get; }

Begins tracking a new operation (slice).

System.IDisposable BeginSlice(string name);

name string
The name that should appear in the trace log/visualization.

A disposable instance which, when disposed, stops tracking this operation and records the duration it took, for subsequent writing to the trace file.

Slices must be disposed in the opposite order in which they are created, otherwise the final trace may be considered invalid.

Starts a new trace.

void BeginTrace();

Ends the current trace and writes all recorded data to a new trace file in the output directory.

void EndTrace();