Struct FeatureFlagEvaluations 

pub struct FeatureFlagEvaluations { /* private fields */ }

A snapshot of evaluated feature flags for one distinct_id.

Returned by Client::evaluate_flags. Reading flags via is_enabled or get_flag both records the access (so it can be later attached to a capture event) and emits a deduplicated $feature_flag_called event. get_flag_payload is intentionally event-free.

Implementations

impl FeatureFlagEvaluations

pub fn is_enabled(&self, key: &str) -> bool

Whether key is enabled. Records the access and fires (deduplicated) $feature_flag_called.

pub fn get_flag(&self, key: &str) -> Option<FlagValue>

Look up the value of key. Returns:

• None when the flag is not in the snapshot,
• Some(FlagValue::Boolean(false)) when disabled,
• Some(FlagValue::String(variant)) for a multivariate match,
• Some(FlagValue::Boolean(true)) when enabled with no variant.

Records the access and fires (deduplicated) $feature_flag_called.

pub fn get_flag_payload(&self, key: &str) -> Option<Value>

Return the JSON payload associated with key, if any. This call does not count as an access and does not fire any event.

pub fn keys(&self) -> Vec<String>

All flag keys present in this snapshot.

pub fn only_accessed(&self) -> Self

A clone of the snapshot containing only flags whose values were read via is_enabled or get_flag before this call.

Order-dependent: if nothing has been accessed yet, the returned snapshot is empty. Pre-access the flags you want to attach before calling this.

pub fn only(&self, keys: &[&str]) -> Self

A clone of the snapshot containing only the listed keys (preserving records). Unknown keys are dropped and surfaced via a single warning.

Trait Implementations

impl Debug for FeatureFlagEvaluations

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

Formats the value using the given formatter.