Struct FeatureFlag 

pub struct FeatureFlag {
    pub key: String,
    pub description: Option<String>,
    pub enabled: bool,
    pub targeting: Vec<TargetingRule>,
    pub default_variation: Variation,
    pub variations: Vec<Variation>,
    pub rollout: Option<Rollout>,
}

Feature flag

Fields

key: String

Flag key/name

description: Option<String>

Flag description

enabled: bool

Whether flag is enabled globally

targeting: Vec<TargetingRule>

Targeting rules

default_variation: Variation

Default variation when no rules match

variations: Vec<Variation>

All available variations

rollout: Option<Rollout>

Rollout configuration

Implementations

impl FeatureFlag

pub fn boolean(key: impl Into<String>, default_value: bool) -> Self

Create a new simple boolean feature flag

The default_value parameter specifies what value to return when no targeting rules match. The flag is enabled by default (can be disabled with flag.enabled = false).

Examples

use armature_features::FeatureFlag;

let flag = FeatureFlag::boolean("new-ui", true);

pub fn multivariate(key: impl Into<String>, variations: Vec<Variation>) -> Self

Create a new multivariate feature flag

pub fn with_description(self, description: impl Into<String>) -> Self

Set description

pub fn with_rule(self, rule: TargetingRule) -> Self

Add targeting rule

pub fn with_rollout(self, rollout: Rollout) -> Self

Set rollout configuration

pub fn evaluate(&self, context: &EvaluationContext) -> Variation

Evaluate flag for a context

Trait Implementations

impl Clone for FeatureFlag

fn clone(&self) -> FeatureFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeatureFlag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FeatureFlag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FeatureFlag

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

where __S: Serializer,

Serialize this value into the given Serde serializer.