Struct Statsig 

pub struct Statsig {
    pub statsig_runtime: Arc<StatsigRuntime>,
    pub options: Arc<StatsigOptions>,
    pub event_emitter: SdkEventEmitter,
    /* private fields */
}

Fields

statsig_runtime: Arc<StatsigRuntime>

options: Arc<StatsigOptions>

event_emitter: SdkEventEmitter

Implementations

impl Statsig

pub fn new(sdk_key: &str, options: Option<Arc<StatsigOptions>>) -> Self

pub async fn initialize(&self) -> Result<(), StatsigErr>

Initializes the Statsig client and returns an error if initialization fails.

This method performs the client initialization and returns Ok(()) if successful. If the initialization completes with failure details, it returns a StatsigErr describing the failure.

For detailed information about the initialization process—regardless of success or failure— use [initialize_with_details] instead.

Errors

Returns a StatsigErr if the client fails to initialize successfully.

pub async fn initialize_with_details( &self, ) -> Result<InitializeDetails, StatsigErr>

Initializes the Statsig client and returns detailed information about the process.

This method returns a InitializeDetails struct, which includes metadata such as the success status, initialization source, and any failure details. Even if initialization fails, this method does not return an error; instead, the init_success field will be false and failure_details may be populated.

Returns

Returns a InitializeDetails struct, which includes metadata such as the success status, initialization source, and any failure details.

pub fn get_initialize_details(&self) -> InitializeDetails

pub fn is_initialized(&self) -> bool

pub async fn shutdown(&self) -> Result<(), StatsigErr>

pub async fn shutdown_with_timeout( &self, timeout: Duration, ) -> Result<(), StatsigErr>

pub fn get_context(&self) -> StatsigContext

impl Statsig

pub fn shared() -> Arc<Statsig>

pub fn new_shared( sdk_key: &str, options: Option<Arc<StatsigOptions>>, ) -> Result<Arc<Statsig>, StatsigErr>

pub fn remove_shared()

pub fn has_shared_instance() -> bool

impl Statsig

pub fn get_client_init_response(&self, user: &StatsigUser) -> InitializeResponse

pub fn get_client_init_response_with_options( &self, user: &StatsigUser, options: &ClientInitResponseOptions, ) -> InitializeResponse

pub fn get_client_init_response_as_string(&self, user: &StatsigUser) -> String

pub fn get_client_init_response_with_options_as_string( &self, user: &StatsigUser, options: &ClientInitResponseOptions, ) -> String

impl Statsig

pub fn log_event( &self, user: &StatsigUser, event_name: &str, value: Option<String>, metadata: Option<HashMap<String, String>>, )

pub fn log_event_with_number( &self, user: &StatsigUser, event_name: &str, value: Option<f64>, metadata: Option<HashMap<String, String>>, )

pub fn forward_log_line_event( &self, user: &StatsigUser, log_level: StatsigLogLineLevel, value: Option<String>, metadata: Option<HashMap<String, String>>, )

pub fn log_layer_param_exposure_with_layer_json( &self, layer_json: String, parameter_name: String, )

pub fn log_layer_param_exposure_with_layer( &self, layer: Layer, parameter_name: String, )

pub async fn flush_events(&self)

impl Statsig

pub fn get_string_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<String>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<String>

pub fn get_boolean_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<bool>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<bool>

pub fn get_float_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<f64>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<f64>

pub fn get_integer_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<i64>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<i64>

pub fn get_array_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<Vec<Value>>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<Vec<Value>>

pub fn get_object_parameter_from_store( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<HashMap<String, Value>>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<HashMap<String, Value>>

pub fn get_parameter_from_store<T: DeserializeOwned>( &self, user: &StatsigUser, parameter_store_name: &str, parameter_name: &str, fallback: Option<T>, options: Option<ParameterStoreEvaluationOptions>, ) -> Option<T>

pub fn get_parameter_store( &self, parameter_store_name: &str, ) -> ParameterStore<'_>

pub fn get_parameter_store_with_options( &self, parameter_store_name: &str, options: ParameterStoreEvaluationOptions, ) -> ParameterStore<'_>

impl Statsig

pub fn identify(&self, user: &StatsigUser)

impl Statsig

pub fn get_cmab_ranked_groups( &self, user: &StatsigUser, cmab_name: &str, ) -> Vec<CMABRankedGroup>

pub fn log_cmab_exposure_for_group( &self, user: &StatsigUser, cmab_name: &str, group_id: String, )

impl Statsig

pub fn override_gate(&self, gate_name: &str, value: bool, id: Option<&str>)

pub fn override_dynamic_config( &self, config_name: &str, value: HashMap<String, Value>, id: Option<&str>, )

pub fn override_layer( &self, layer_name: &str, value: HashMap<String, Value>, id: Option<&str>, )

pub fn override_experiment( &self, experiment_name: &str, value: HashMap<String, Value>, id: Option<&str>, )

pub fn override_experiment_by_group_name( &self, experiment_name: &str, group_name: &str, id: Option<&str>, )

pub fn remove_gate_override(&self, gate_name: &str, id: Option<&str>)

pub fn remove_dynamic_config_override( &self, config_name: &str, id: Option<&str>, )

pub fn remove_experiment_override( &self, experiment_name: &str, id: Option<&str>, )

pub fn remove_layer_override(&self, layer_name: &str, id: Option<&str>)

pub fn remove_all_overrides(&self)

impl Statsig

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

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

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

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

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

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

pub fn __get_parsed_user_agent_value( &self, user: &StatsigUser, ) -> Option<ParsedUserAgentValue>

impl Statsig

pub fn check_gate(&self, user: &StatsigUser, gate_name: &str) -> bool

pub fn check_gate_with_options( &self, user: &StatsigUser, gate_name: &str, options: FeatureGateEvaluationOptions, ) -> bool

pub fn get_feature_gate( &self, user: &StatsigUser, gate_name: &str, ) -> FeatureGate

pub fn get_feature_gate_with_options( &self, user: &StatsigUser, gate_name: &str, options: FeatureGateEvaluationOptions, ) -> FeatureGate

pub fn manually_log_gate_exposure(&self, user: &StatsigUser, gate_name: &str)

pub fn get_fields_needed_for_gate(&self, gate_name: &str) -> Vec<String>

impl Statsig

pub fn get_dynamic_config( &self, user: &StatsigUser, dynamic_config_name: &str, ) -> DynamicConfig

pub fn get_dynamic_config_with_options( &self, user: &StatsigUser, dynamic_config_name: &str, options: DynamicConfigEvaluationOptions, ) -> DynamicConfig

pub fn manually_log_dynamic_config_exposure( &self, user: &StatsigUser, dynamic_config_name: &str, )

pub fn get_fields_needed_for_dynamic_config( &self, config_name: &str, ) -> Vec<String>

impl Statsig

pub fn get_experiment( &self, user: &StatsigUser, experiment_name: &str, ) -> Experiment

pub fn get_experiment_with_options( &self, user: &StatsigUser, experiment_name: &str, options: ExperimentEvaluationOptions, ) -> Experiment

pub fn manually_log_experiment_exposure( &self, user: &StatsigUser, experiment_name: &str, )

pub fn get_fields_needed_for_experiment( &self, experiment_name: &str, ) -> Vec<String>

pub fn get_experiment_by_group_name( &self, experiment_name: &str, group_name: &str, ) -> Experiment

impl Statsig

pub fn get_layer(&self, user: &StatsigUser, layer_name: &str) -> Layer

pub fn get_layer_with_options( &self, user: &StatsigUser, layer_name: &str, options: LayerEvaluationOptions, ) -> Layer

pub fn manually_log_layer_parameter_exposure( &self, user: &StatsigUser, layer_name: &str, parameter_name: String, )

pub fn get_fields_needed_for_layer(&self, layer_name: &str) -> Vec<String>

Methods from Deref<Target = SdkEventEmitter>

pub fn subscribe<F>(&self, event: &str, callback: F) -> SubscriptionID

where F: Fn(SdkEvent<'_>) + Send + Sync + 'static,

pub fn unsubscribe(&self, event: &str)

pub fn unsubscribe_by_id(&self, subscription_id: &SubscriptionID)

pub fn unsubscribe_all(&self)

Trait Implementations

impl Drop for Statsig

fn drop(&mut self)

Executes the destructor for this type.

impl Deref for Statsig

type Target = SdkEventEmitter

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.