Struct TracyClient 

pub struct TracyClient { /* private fields */ }

Handle to the (Pure Rust) trace-event profiler client.

Construct once at application start with TracyClient::new and keep the handle alive for the duration of profiling. All methods are safe no-ops when the tracy feature is not enabled.

Implementations

impl TracyClient

pub fn new() -> Self

Initialise the profiler client.

When the tracy feature is enabled this forces initialisation of the process-global trace-event buffer and epoch clock. When the feature is absent this is a pure no-op constructor.

pub fn is_active(&self) -> bool

Returns true when profiling is active (i.e. the tracy feature is enabled and the client was started successfully).

pub fn span(&self, name: &str) -> TracySpan

Begin a named profiling zone. The returned TracySpan ends the zone (and records a complete 'X' trace event) when dropped.

When the tracy feature is disabled this is a zero-cost no-op.

pub fn frame_mark(&self, name: &str)

Mark a named frame boundary.

Recorded as an instant ('i') trace event with global scope. When the tracy feature is disabled this is a no-op.

pub fn message(&self, msg: &str)

Emit a free-form message to the trace-event log.

Recorded as an instant ('i') trace event carrying the message as an argument payload. When the tracy feature is disabled this is a no-op.

pub fn export_chrome_trace(&self, path: impl AsRef<Path>) -> Result<()>

Export all recorded trace events as a Chrome Trace Event Format JSON document, viewable at https://ui.perfetto.dev or chrome://tracing.

This method is always available and always safe to call: when the tracy feature is disabled it writes the valid-but-empty document {"traceEvents":[],"displayTimeUnit":"ns"} rather than being conditionally compiled out, so callers never need feature guards around the export call itself.

Trait Implementations

impl Default for TracyClient

fn default() -> Self

Returns the “default value” for a type.