bullettrain 0.1.0

Bullet Train SDK for Rust
Documentation

Bullet Train SDK for Rust

Bullet Train allows you to manage feature flags and remote config across multiple projects, environments and organisations.

This is the SDK for Rust for https://bullet-train.io/.

Getting Started

Usage

Retrieving feature flags for your project

For full documentation visit https://docs.bullet-train.io

Sign Up and create account at https://bullet-train.io/

In your application initialise the BulletTrain client with your API key

let bt = bullettrain::Client::new("<Your API Key>");

To check if a feature flag exists and is enabled:

let bt = bullettrain::Client::new("<Your API Key>");
if bt.feature_enabled("cart_abundant_notification_ab_test_enabled")? {
    println!("Feature enabled");
}

To get the configuration value for feature flag value:

use bullettrain::{Client,Value};

let bt = bullettrain::Client::new("<Your API Key>");

if let Some(Value::String(s)) = bt.get_value("cart_abundant_notification_ab_test")? {
    println!("{}", s);
}

More examples can be found in the Tests

Override default configuration

By default, client is using default configuration. You can override configuration as follows:

let bt = bullettrain::Client {
    api_key: String::from("secret key"),
    base_uri: String::from("https://features.on.my.own.server/api/v1/"),
};

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Getting Help

If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.

Get in touch

If you have any questions about our projects you can email support@bullet-train.io.