Struct MetricGoalConfig 

#[non_exhaustive]
pub struct MetricGoalConfig {
    pub metric_definition: Option<MetricDefinitionConfig>,
    pub desired_change: Option<ChangeDirectionEnum>,
}

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metric_definition: Option<MetricDefinitionConfig>

A structure that contains details about the metric.

desired_change: Option<ChangeDirectionEnum>

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

Implementations

impl MetricGoalConfig

pub fn metric_definition(&self) -> Option<&MetricDefinitionConfig>

A structure that contains details about the metric.

pub fn desired_change(&self) -> Option<&ChangeDirectionEnum>

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

impl MetricGoalConfig

pub fn builder() -> MetricGoalConfigBuilder

Creates a new builder-style object to manufacture MetricGoalConfig.

Trait Implementations

impl Clone for MetricGoalConfig

fn clone(&self) -> MetricGoalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricGoalConfig

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

Formats the value using the given formatter.

impl PartialEq for MetricGoalConfig

fn eq(&self, other: &MetricGoalConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MetricGoalConfig