#flags #toggle #features #flipper

feattle-core

Featture toggles for Rust, extensible and with background synchronization and administration UI

15 releases (2 stable)

2.0.0 Jun 26, 2024
1.0.0 Jun 28, 2023
0.9.0 Jul 11, 2022
0.8.0 Mar 16, 2022
0.2.5 Oct 23, 2020

#794 in Configuration

Download history 161/week @ 2024-03-27 218/week @ 2024-04-03 189/week @ 2024-04-10 146/week @ 2024-04-17 99/week @ 2024-04-24 180/week @ 2024-05-01 115/week @ 2024-05-08 146/week @ 2024-05-15 192/week @ 2024-05-22 261/week @ 2024-05-29 122/week @ 2024-06-05 130/week @ 2024-06-12 170/week @ 2024-06-19 321/week @ 2024-06-26 233/week @ 2024-07-03 160/week @ 2024-07-10

938 downloads per month
Used in 3 crates

MIT/Apache

64KB
1K SLoC

feattle-core

Crates.io Docs.rs CI Coverage Status

This crate is the core implementation of the feature flags (called "feattles", for short).

Its main parts are the macro feattles! together with the trait Feattles. Please refer to the main package - feattle for more information.

Usage example

use std::sync::Arc;
use feattle_core::{feattles, Feattles};
use feattle_core::persist::NoPersistence;

// Declare the struct
feattles! {
    struct MyFeattles {
        /// Is this usage considered cool?
        is_cool: bool = true,
        /// Limit the number of "blings" available.
        /// This will not change the number of "blengs", though!
        max_blings: i32,
        /// List the actions that should not be available
        blocked_actions: Vec<String>,
    }
}

// Create a new instance (`NoPersistence` is just a mock for the persistence layer)
let my_feattles = MyFeattles::new(Arc::new(NoPersistence));

// Read values (note the use of `*`)
assert_eq!(*my_feattles.is_cool(), true);
assert_eq!(*my_feattles.max_blings(), 0);
assert_eq!(*my_feattles.blocked_actions(), Vec::<String>::new());

How it works

The macro will generate a struct with the given name and visibility modifier (assuming private by default). The generated struct implements Feattles and also exposes one method for each feattle.

The methods created for each feattle allow reading their current value. For example, for a feattle is_cool: bool, there will be a method like pub fn is_cool(&self) -> MappedRwLockReadGuard<bool>. Note the use of parking_lot::MappedRwLockReadGuard because the interior of the struct is stored behind a RwLock to control concurrent access.

A feattle is created with the syntax $key: $type [= $default]. You can use doc coments ( starting with ///) to describe nicely what they do in your system. You can use any type that implements FeattleValue and optionally provide a default. If not provided, the default will be created with Default::default().

Updating values

This crate only disposes of low-level methods to load current feattles with [Feattles::reload()] and update their values with [Feattles::update()]. Please look for the crates feattle-sync and feattle-ui for higher-level functionalities.

Limitations

Due to some restrictions on how the macro is written, you can only use feattles! once per module. For example, the following does not compile:

use feattle_core::feattles;

feattles! { struct A { } }
feattles! { struct B { } }

You can work around this limitation by creating a sub-module and then re-exporting the generated struct. Note the use of pub struct in the second case.

use feattle_core::feattles;

feattles! { struct A { } }

mod b {
    use feattle_core::feattles;
    feattles! { pub struct B { } }
}

use b::B;

Optional features

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

Dependencies

~2–8MB
~63K SLoC