Enum Reason

pub enum Reason {
    Off,
    TargetMatch,
    RuleMatch {
        rule_index: usize,
        rule_id: String,
        in_experiment: bool,
    },
    PrerequisiteFailed {
        prerequisite_key: String,
    },
    Fallthrough {
        in_experiment: bool,
    },
    Error {
        error: Error,
    },
}

Reason describes the reason that a flag evaluation produced a particular value.

Variants

Off

Off indicates that the flag was off and therefore returned its configured off value.

TargetMatch

TargetMatch indicates that context key was specifically targeted for this flag.

RuleMatch

RuleMatch indicates that the context matched one of the flag’s rules.

Fields

rule_index: usize

Zero-based index of the crate::FlagRule that was matched.

rule_id: String

The id property of the crate::FlagRule::id that was matched.

in_experiment: bool

This optional boolean property is true if the variation was determined by a crate::Rollout whose kind was crate::RolloutKind::Experiment and if the selected crate::WeightedVariation did not have an untracked property of true. It is false otherwise.

PrerequisiteFailed

PrerequisiteFailed indicates that the flag was considered off because it had at least one prerequisite flag that either was off or did not return the desired variation.

Fields

prerequisite_key: String

The key of the prerequisite flag that failed.

Fallthrough

Fallthrough indicates that the flag was on but the context did not match any targets or rules.

Fields

in_experiment: bool

This optional boolean property is true if the variation was determined by a crate::Rollout whose kind was crate::RolloutKind::Experiment and if the selected crate::WeightedVariation did not have an untracked property of true. It is false otherwise.

Error

Error indicates that the flag could not be evaluated, e.g. because it does not exist or due to an unexpected error. In this case the result value will be the default value that the caller passed to the client.

Fields

error: Error

An error representing the Reason::Error.

Implementations

impl Reason

pub fn is_in_experiment(&self) -> bool

This method determines whether or not the provided Reason is considered to be part of an ongoing experiment.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl PartialEq for Reason

fn eq(&self, other: &Reason) -> 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 Serialize for Reason

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reason