Struct Token

pub struct Token { /* private fields */ }

An in progress COGS measurement.

The measurement is recorded when the token is dropped.

Implementations

impl Token

pub fn noop() -> Self

Creates a new no-op token, which records nothing.

This is primarily useful for testing.

pub fn cancel(&mut self)

Cancels the COGS measurement.

pub fn start_category(&mut self, category: impl Category) -> CategoryToken<'_>

Starts a categorized measurement.

The measurement is finalized when the returned CategoryToken is dropped.

Instead of manually starting a categorized measurement, the crate::with macro can be used.

pub fn update<T: Into<FeatureWeights>>(&mut self, features: T)

Updates the app features to which the active measurement is attributed to.

Example:

fn process(cogs: &Cogs, item: &Item) {
    let mut token = cogs.timed(ResourceId::Relay, AppFeature::Unattributed);

    // App feature is only known after some computations.
    if do_something(item) {
        token.update(AppFeature::Spans);
    } else {
        token.update(AppFeature::Transactions);
    }
}

Trait Implementations

impl Debug for Token

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Token

fn drop(&mut self)

Executes the destructor for this type.