bevy_mod_config 0.2.1

A Bevy plugin for configuration management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use crate::ConfigField;

/// Implemented by the discriminant type generated by [`crate::Config`] when derived for enums.
///
/// [Managers](crate::Manager) that support enum config fields should blanket-implement
/// [`manager::Supports<T>`](crate::manager::Supports) for all `T: EnumDiscriminant`.
pub trait EnumDiscriminant: ConfigField + Eq + Sized + Copy + Send + Sync + 'static {
    /// Lists all variants of the enum.
    const VARIANTS: &'static [Self];

    /// Returns the index of the variant in [`VARIANTS`](Self::VARIANTS).
    fn into_usize(self) -> usize;

    /// Returns the enum variant name.
    fn name(self) -> &'static str;

    /// Returns the enum variant with the given name if any.
    fn from_name(name: &str) -> Option<Self>;
}

/// A [`ConfigField`] implementation that wraps an [`EnumDiscriminant`] implementor.
#[derive(PartialEq)]
pub struct EnumDiscriminantWrapper<T>(pub T);

/// [Metadata](ConfigField::Metadata) type for enum discriminants.
#[derive(Default, Clone)]
pub struct EnumDiscriminantMetadata<T> {
    /// The default variant.
    pub default:     T,
    /// Display as a step slider instead of a combo box.
    pub step_slider: bool,
}