Crate tracy_client

This crate is a set of safe bindings to the client library of the Tracy profiler.

If you have already instrumented your application with tracing, consider the tracing-tracy crate.

Important note

Depending on the configuration Tracy may broadcast discovery packets to the local network and expose the data it collects in the background to that same network. Traces collected by Tracy may include source and assembly code as well.

As thus, you may want make sure to only enable the tracy-client crate conditionally, via the enable feature flag provided by this crate.

Features

Refer to the sys crate for documentation on crate features. This crate re-exports all the features from sys.

Re-exports

pub use sys;

Macros

frame_name

Construct a FrameName.

non_continuous_frame

Convenience macro for Client::non_continuous_frame on the current client.

plot

Convenience macro for Client::plot on the current client.

plot_name

Construct a PlotName.

secondary_frame_mark

Convenience macro for Client::secondary_frame_mark on the current client.

set_thread_name

Convenience macro for Client::set_thread_name on the current client.

span

Start a new Tracy span with function, file, and line determined automatically.

span_location

Construct a &’static SpanLocation.

Structs

Client

A type representing an enabled Tracy client.

Frame

A non-continuous frame region.

FrameName

A name for secondary and non-continuous frames.

PlotName

Name of a plot.

ProfiledAllocator

A profiling wrapper around another allocator.

Span

A handle representing a span of execution.

SpanLocation

A statically allocated location information for a span.

Functions

frame_mark

Convenience shortcut for Client::frame_mark on the current client.