Struct puffin::ThreadProfiler

pub struct ThreadProfiler { /* private fields */ }

Collects profiling data for one thread

Implementations

impl ThreadProfiler

pub fn initialize( now_ns: fn() -> NanoSecond, reporter: fn(_: ThreadInfo, _: &[ScopeDetails], _: &StreamInfoRef<'_>), )

Explicit initialize with custom callbacks.

If not called, each thread will use the default nanosecond source (crate::now_ns) and report scopes to the global profiler (internal_profile_reporter).

For instance, when compiling for WASM the default timing function (crate::now_ns) won’t work, so you’ll want to call puffin::ThreadProfiler::initialize(my_timing_function, internal_profile_reporter);.

pub fn register_function_scope( &mut self, function_name: impl Into<Cow<'static, str>>, file_path: impl Into<Cow<'static, str>>, line_nr: u32, ) -> ScopeId

Register a function scope.

pub fn register_named_scope( &mut self, scope_name: impl Into<Cow<'static, str>>, function_name: impl Into<Cow<'static, str>>, file_path: impl Into<Cow<'static, str>>, line_nr: u32, ) -> ScopeId

Register a named scope.

pub fn begin_scope(&mut self, scope_id: ScopeId, data: &str) -> usize

Marks the beginning of the scope. Returns position where to write scope size once the scope is closed.

pub fn end_scope(&mut self, start_offset: usize)

Marks the end of the scope. Returns the current depth.

pub fn call<R>(f: impl Fn(&mut Self) -> R) -> R

Do something with the thread local ThreadProfiler

Trait Implementations

impl Default for ThreadProfiler

fn default() -> Self

Returns the “default value” for a type.