Adding `flipt` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add flipt

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

flipt = "1.4.0"

The flipt library will be automatically available globally. Read the flipt library documentation.

Back to the crate overview.

Readme

Flipt Rust

This directory contains the Rust source code for the Flipt server-side client.

Documentation

API documentation is available at https://www.flipt.io/docs/reference/overview.

Installation

cargo add flipt

Usage

In your Rust code you can import this client and use it as so:

use std::collections::HashMap;

use flipt::api::FliptClient;
use flipt::evaluation::models::EvaluationRequest;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = FliptClient::default();

    let mut context: HashMap<String, String> = HashMap::new();

    context.insert("fizz".into(), "buzz".into());

    let variant_result = client
        .evaluation
        .variant(&EvaluationRequest {
            namespace_key: "default".into(),
            flag_key: "flag1".into(),
            entity_id: "entity".into(),
            context: context.clone(),
            reference: None,
        })
        .await
        .unwrap();

    print!("{:?}", variant_result);

There is a more detailed example in the examples directory.

Setting HTTP Headers

You can set custom HTTP headers for the client by using the with_headers method in the ConfigBuilder.

let client = FliptClient::new(ConfigBuilder::default().with_headers(HeaderMap::new()).build());

Flipt V2 Environment Support

Flipt V2 introduces the concept of environments. This client supports evaluation of flags in a specific environment by using the X-Flipt-Environment header.

let client = FliptClient::new(ConfigBuilder::default().with_headers(HeaderMap::from_iter([("X-Flipt-Environment".into(), "production".into())])).build());

Adding flipt library as a dependency

Adding `flipt` library as a dependency