Struct relay_cogs::FeatureWeights

pub struct FeatureWeights(/* private fields */);

A collection of weighted app features.

Used to attribute a single COGS measurement to multiple features.

Implementations

impl FeatureWeights

pub fn new(feature: AppFeature) -> Self

Attributes all measurements to a single AppFeature.

pub fn none() -> Self

Attributes the measurement to nothing.

pub fn builder() -> FeatureWeightsBuilder

Returns an FeatureWeights builder.

pub fn merge(self, other: Self) -> Self

Merges two instances of FeatureWeights and sums the contained weights.

pub fn weights(&self) -> impl Iterator<Item = (AppFeature, f32)> + '_

Returns an iterator yielding an app feature and it’s associated weight.

Weights are normalized to the total stored weights in the range between 0.0 and 1.0. Used to divide a measurement by the stored weights.

Examples

use relay_cogs::{AppFeature, FeatureWeights};
use std::collections::HashMap;

let app_features = FeatureWeights::builder()
    .weight(AppFeature::Transactions, 1)
    .weight(AppFeature::Spans, 1)
    .build();

let weights: HashMap<AppFeature, f32> = app_features.weights().collect();
assert_eq!(weights, HashMap::from([(AppFeature::Transactions, 0.5), (AppFeature::Spans, 0.5)]))

pub fn is_empty(&self) -> bool

Returns true if there are no weights contained.

Examples

use relay_cogs::{AppFeature, FeatureWeights};

assert!(FeatureWeights::none().is_empty());
assert!(!FeatureWeights::new(AppFeature::Spans).is_empty());

Trait Implementations

impl Clone for FeatureWeights

fn clone(&self) -> FeatureWeights

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FeatureWeights

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

Formats the value using the given formatter.

impl From<AppFeature> for FeatureWeights

fn from(value: AppFeature) -> Self

Converts to this type from the input type.