Struct Client

pub struct Client { /* private fields */ }

The OpenFeature client. Create it through the [OpenFeature] struct.

Implementations

impl Client

pub fn new( name: impl Into<String>, global_evaluation_context: GlobalEvaluationContext, global_hooks: GlobalHooks, provider_registry: ProviderRegistry, ) -> Self

Create a new Client instance.

pub fn metadata(&self) -> &ClientMetadata

Return the metadata of current client.

pub fn set_evaluation_context(&mut self, evaluation_context: EvaluationContext)

Set evaluation context to the client.

pub async fn get_bool_value( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<bool>

Evaluate given flag_key with corresponding evaluation_context and evaluation_options as a bool value.

pub async fn get_int_value( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<i64>

Evaluate given flag_key with corresponding evaluation_context and evaluation_options as an int (i64) value.

pub async fn get_float_value( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<f64>

Evaluate given flag_key with corresponding evaluation_context and evaluation_options as a float (f64) value. If the resolution fails, the default_value is returned.

pub async fn get_string_value( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<String>

Evaluate given flag_key with corresponding evaluation_context and evaluation_options as a string value. If the resolution fails, the default_value is returned.

pub async fn get_struct_value<T: TryFrom<StructValue>>( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<T>

Evaluate given flag_key with corresponding evaluation_context and evaluation_options as a struct. If the resolution fails, the default_value is returned. The required type should implement From<StructValue> trait.

pub async fn get_bool_details( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<EvaluationDetails<bool>>

Return the EvaluationDetails with given flag_key, evaluation_context and evaluation_options.

pub async fn get_int_details( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<EvaluationDetails<i64>>

Return the EvaluationDetails with given flag_key, evaluation_context and evaluation_options.

pub async fn get_float_details( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<EvaluationDetails<f64>>

Return the EvaluationDetails with given flag_key, evaluation_context and evaluation_options.

pub async fn get_string_details( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<EvaluationDetails<String>>

Return the EvaluationDetails with given flag_key, evaluation_context and evaluation_options.

pub async fn get_struct_details<T: TryFrom<StructValue>>( &self, flag_key: &str, evaluation_context: Option<&EvaluationContext>, evaluation_options: Option<&EvaluationOptions>, ) -> EvaluationResult<EvaluationDetails<T>>

Return the EvaluationDetails with given flag_key, evaluation_context and evaluation_options.

impl Client

pub fn with_hook<T: Hook>(self, hook: T) -> Self

Add a hook to the client.

pub fn with_logging_hook(self, include_evaluation_context: bool) -> Self

Add logging hook to the client.