Struct xi_trace::Trace

pub struct Trace { /* fields omitted */ }

Stores the tracing data.

Methods

impl Trace

pub fn disabled() -> Self

pub fn enabled(config: Config) -> Self

pub fn disable(&self)

pub fn enable(&self)

pub fn enable_config(&self, config: Config)

pub fn get_samples_count(&self) -> usize

Generally racy since the underlying storage might be mutated in a separate thread. Exposed for unit tests.

pub fn get_samples_limit(&self) -> usize

Exposed for unit tests only.

pub fn is_enabled(&self) -> bool

pub fn instant<S, C>(&self, name: S, categories: C) where
    S: Into<StrCow>,
    C: Into<CategoriesT>, 

pub fn instant_payload<S, C, P>(&self, name: S, categories: C, payload: P) where
    S: Into<StrCow>,
    C: Into<CategoriesT>,
    P: Into<TracePayloadT>, 

pub fn block<S, C>(&self, name: S, categories: C) -> SampleGuard where
    S: Into<StrCow>,
    C: Into<CategoriesT>, 

pub fn block_payload<S, C, P>(
    &self,
    name: S,
    categories: C,
    payload: P
) -> SampleGuard where
    S: Into<StrCow>,
    C: Into<CategoriesT>,
    P: Into<TracePayloadT>, 

pub fn closure<S, C, F, R>(&self, name: S, categories: C, closure: F) -> R where
    S: Into<StrCow>,
    C: Into<CategoriesT>,
    F: FnOnce() -> R, 

pub fn closure_payload<S, C, P, F, R>(
    &self,
    name: S,
    categories: C,
    closure: F,
    payload: P
) -> R where
    S: Into<StrCow>,
    C: Into<CategoriesT>,
    P: Into<TracePayloadT>,
    F: FnOnce() -> R, 

pub fn samples_cloned_unsorted(&self) -> Vec<Sample>

pub fn samples_cloned_sorted(&self) -> Vec<Sample>

pub fn save<P: AsRef<Path>>(&self, path: P, sort: bool) -> Result<(), Error>