Struct FlagBuilder 

pub struct FlagBuilder { /* private fields */ }

Builder for constructing test flags with various configurations.

The flag builder provides a fluent API for creating flags with targeting rules, variations, and other configuration options. This is the primary way to create test flags for use in testing and development scenarios.

Implementations

impl FlagBuilder

pub fn key(&self) -> &str

Returns the flag key for this builder.

pub fn new(key: impl Into<String>) -> Self

Creates a new flag builder for the given flag key.

If creating a new flag, it will be initialized as a boolean flag with:

• Variations: [true, false]
• Targeting enabled (on: true)
• Fallthrough variation: 0 (true)
• Off variation: 1 (false)

pub fn boolean_flag(self) -> Self

Configures the flag as a boolean type with variations [true, false].

Sets:

• Variations: [true, false]
• Fallthrough variation: 0 (true)
• Off variation: 1 (false)

pub fn variations<I>(self, variations: I) -> Self

where I: IntoIterator<Item = FlagValue>,

Sets the variations for this flag.

pub fn on(self, on: bool) -> Self

Sets whether targeting is enabled for the flag.

When targeting is off (false), the flag returns the off variation regardless of other configuration.

pub fn fallthrough_variation(self, value: bool) -> Self

Sets the fallthrough variation for boolean flags.

This is a convenience method equivalent to calling fallthrough_variation_index with 0 for true or 1 for false.

pub fn fallthrough_variation_index(self, index: usize) -> Self

Sets the fallthrough variation by index.

The fallthrough variation is returned when targeting is on but no targets or rules match.

pub fn off_variation(self, value: bool) -> Self

Sets the off variation for boolean flags.

This is a convenience method equivalent to calling off_variation_index with 0 for true or 1 for false.

pub fn off_variation_index(self, index: usize) -> Self

Sets the off variation by index.

The off variation is returned when targeting is disabled (on: false).

pub fn variation_for_all(self, value: bool) -> Self

Configures the flag to always return the specified boolean value for everyone.

This is a convenience method that:

• Enables targeting (on: true)
• Removes all targets and rules
• Sets the fallthrough variation to the specified value

pub fn variation_for_all_index(self, index: usize) -> Self

Configures the flag to always return the specified variation index for everyone.

This is a convenience method that:

• Enables targeting (on: true)
• Removes all targets and rules
• Sets the fallthrough variation to the specified index

pub fn value_for_all(self, value: FlagValue) -> Self

Configures the flag to always return the specified value.

This is a convenience method that:

• Sets a single variation equal to the specified value
• Enables targeting (on: true)
• Removes all targets and rules
• Sets both fallthrough and off variation to index 0

pub fn variation_for_user( self, user_key: impl Into<String>, variation: bool, ) -> Self

Configures the flag to return a specific boolean value for a user context.

This is a convenience method for targeting contexts with kind: “user”.

pub fn variation_for_key( self, context_kind: Kind, key: impl Into<String>, variation: bool, ) -> Self

Configures the flag to return a specific boolean value for a context of any kind.

pub fn variation_index_for_user( self, user_key: impl Into<String>, variation: usize, ) -> Self

Configures the flag to return a specific variation index for a user context.

This is a convenience method for targeting contexts with kind: “user”.

pub fn variation_index_for_key( self, context_kind: Kind, key: impl Into<String>, variation: usize, ) -> Self

Configures the flag to return a specific variation index for a context of any kind.

When a context key is targeted, that key is automatically removed from targeting for any other variation of the same flag (a key can only be targeted for one variation at a time).

pub fn clear_targets(self) -> Self

Removes all individual context targets from the flag.

pub fn if_match<I>(self, attribute: impl Into<String>, values: I) -> RuleBuilder

where I: IntoIterator<Item = AttributeValue>,

Creates a rule that matches when the specified user attribute equals any of the provided values.

This is a convenience method for creating rules that target contexts with kind: “user”. Returns a RuleBuilder that can be used to add more conditions or complete the rule.

pub fn if_match_context<I>( self, context_kind: Kind, attribute: impl Into<String>, values: I, ) -> RuleBuilder

where I: IntoIterator<Item = AttributeValue>,

Creates a rule that matches when the specified attribute equals any of the provided values for a context of the specified kind.

Returns a RuleBuilder that can be used to add more conditions or complete the rule.

pub fn if_not_match<I>( self, attribute: impl Into<String>, values: I, ) -> RuleBuilder

where I: IntoIterator<Item = AttributeValue>,

Creates a rule that matches when the specified user attribute does NOT equal any of the provided values.

This is identical to if_match except it uses negated logic.

pub fn if_not_match_context<I>( self, context_kind: Kind, attribute: impl Into<String>, values: I, ) -> RuleBuilder

where I: IntoIterator<Item = AttributeValue>,

Creates a rule that matches when the specified attribute does NOT equal any of the provided values for a context of the specified kind.

pub fn clear_rules(self) -> Self

Removes all rules from the flag.

pub fn sampling_ratio(self, ratio: u32) -> Self

Sets the event sampling ratio for the flag.

pub fn exclude_from_summaries(self, exclude: bool) -> Self

Sets whether the flag should be excluded from summary event counts.

pub fn build(self) -> Flag

Builds the final Flag instance.

This method creates a complete Flag with all configured settings.

Trait Implementations

impl Clone for FlagBuilder

fn clone(&self) -> FlagBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.